Update nvm.sh help command to better explain <version> optionality #2242
Conversation
…ional and can be provided by .nvmrc on `nvm install`, `nvm use`, `nvm exec`, and `nvm run`.
nvm.sh
Outdated
| nvm_echo ' nvm cache clear Empty cache directory for nvm' | ||
| nvm_echo ' nvm --help Show this message' | ||
| nvm_echo ' nvm --version Print out the installed version of nvm' | ||
| nvm_echo ' nvm install [-s] [<version>] Download and install a <version>, [-s] from source. Uses .nvmrc as <version> provider if available' |
There was a problem hiding this comment.
i don't think we need all this extra "as version provider" text; if you don't know what .nvmrc is, it's explained elsewhere, and if you do, you know it's providing a version.
There was a problem hiding this comment.
I have put the 'as provider' to better explain the source of the optional parameter. In any case the important part of this PR are the brackets around the and not this comment. Brackets should be there to keep consistency with other commands of nvm because they denote optionality.
If you agree with the brackets addition and not with the 'as provider' part let me make another PR
There was a problem hiding this comment.
I agree with the brackets for sure :-) i'm just not as convinced on the "as provider" part.
Please don't make another PR; let's just update this one.
There was a problem hiding this comment.
Cool! I have updated it.
Regards
Explains more clearly that parameter is optional and can be provided by .nvmrc on
nvm install,nvm use,nvm execandnvm run.