docs(api): clarify process.argv handling and the order of API methods #1644
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
roryokane
force-pushed
the
api-docs-clarify-intro
branch
from
6a24d8e
to
0ddac0b
Compare
bcoe
approved these changes
Jun 2, 2020
bcoe
approved these changes
Jun 2, 2020
|
@roryokane this seems like a reasonable clarification to me, I'll wait for @mleguen to chime in too. |
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.
The final statement “the rest of these methods below come in just before …” now makes sense for both of these argument-passing styles:
require('yargs').argvrequire('yargs').parse()There is one more argument-passing style I’m not sure how to handle:
require('yargs')([ '-x', '1', '-y', '2' ])I think I once tried putting methods earlier in the chain like
require('yargs').help().([ '-x', '1', '-y', '2' ])and got an error. If anyone knows the correct place to put the chain methods like.optionwhen passing arguments the above way, I can update this PR to describe it.