minor docs and help text improvements #66
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Before: $ gohack help get [snip] It uses $GOHACK/<module> as the destination directory, or $HOME/gohack/<module> if $GOHACK is empty. [snip] No need to escape html entities for the terminal. :)
Since -u hasn't been implemented yet, we shouldn't advertise it in the help text.
Subcommands have been introduced. They don't perfectly match this structure, but it is reasonably close. The TODO comment contains a few as-yet unimplemented ideas for other features and subcommands: * get -u already has a todo in the get flags * rm isn't implemented, but it is also not likely to be forgotten if/when it is needed * dir has lots of overlap with rogpeppe#61, and the issue tracker is a better place to discuss Given that, the outdated comment no longer pulls its weight. Cull it.
|
cc @rogpeppe |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm happy to leave off the last commit if you prefer. I really only meant to send the first commit, but kept noticing stuff. :)