Add usage string for --reinstall-packages-from #797
Merged
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
|
This looks great - and you're right, there's no clear format - but what you chose seems good enough for me. Thanks! |
| @@ -1186,6 +1186,7 @@ nvm() { | |||
| echo " nvm help Show this message" | |||
| echo " nvm --version Print out the latest released version of nvm" | |||
| echo " nvm install [-s] <version> Download and install a <version>, [-s] from source. Uses .nvmrc if available" | |||
| echo " --reinstall-packages-from=<version> When installing, reinstall packages installed in <node|iojs|node version number>" | |||
There was a problem hiding this comment.
node|iojs|node version number isn't entirely accurate, but perhaps (in a separate PR) we should add a line or two above "Usage" explaining what a "version-ish" is (like a commit-ish in git), and then use that term in the command docs whenever it applies.
I'm not attached to the name "version-ish" so other suggestions would be welcome.
ljharb
added a commit
that referenced
this pull request
Aug 6, 2015
Add usage string for --reinstall-packages-from
ljharb
added a commit
to ljharb/nvm
that referenced
this pull request
Aug 6, 2015
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.
@reybango added docs for this switch in the readme in #795. I attempted to add similar info in the
nvm helpusage output. Currently there's no clear format for documenting command switches in this help output (there's another,--copy-packages-fromthat I didn't add info for). If the style I used here is not acceptable that's fine, it can just be a starting point for discussion of how to doc some of these undocumented switches. 🌴