Add comments to shells scripts explaining what they do
danvk opened this issue · 7 comments
For example, I hoped that git-root would cd up to the top level of my git repo. But running it does nothing. A comment would greatly clarify the intent.
yea, you need to . git-root to get that effect, I think.
agreed that probably some of these scripts don't do what they should / could use documentation
I commented the script in question.. can't decide whether to leave this open as a reminder to comment others, or what, since it's not super actionable beyond the one you cited.
not super actionable because there are so many to document? (I'm counting 76 git commands in the root directory)
OK, new scope: make sure every script has a comment
Godspeed, Ryan!
imma do #20 first though
declaring this done as of 08690da