doc: make --no- boolean prefix easier to find in the docs
#1338
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
In my experience, it took too much effort to quickly find an explanation of what `--no-` is doing in the docs. This change should make it easier to find a description of the boolean negation shortcut by searching the api page.
|
@AndrewFinlay thank you 👍 very much appreciate the docs update. |
jandockx
pushed a commit
to jandockx/yargs
that referenced
this pull request
May 7, 2019
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.
Hi all,
I bumped into #1307 while working on another yargs based project and found myself wondering what the
--no-prefix did. I went to the yargs docs, found the api reference and tried searching in there but couldn't find anything. I ended up searching with github's project search to find what I was after.So this change is quite simple, make mention of the
--noboolean prefix on the api doc page and link to the existing doc under parsing tricks. Hopefully that should make it a little quicker to find.