readme: add description of --no behaviour #48
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #48 +/- ##
=======================================
Coverage 98.78% 98.78%
=======================================
Files 1 1
Lines 165 165
Branches 70 70
=======================================
Hits 163 163
Misses 2 2 ☔ View full report in Codecov by Sentry. |
ljharb
approved these changes
Sep 17, 2023
|
After new discussion in #38, I think worth of some explanatory text in addition to the example. |
Also, remove old security warning. Fixes: minimistjs#38
shadowspawn
force-pushed
the
feature/doc--no
branch
from
841c3e6
to
d6fc238
Compare
|
I (hopefully) matched the existing terminology and added a short description of a negated argument, in addition to |
shadowspawn
changed the title
shadowspawn
force-pushed
the
feature/doc--no
branch
from
d6fc238
to
2f1953c
Compare
ljharb
approved these changes
Oct 13, 2023
shadowspawn
force-pushed
the
feature/doc--no
branch
from
2f1953c
to
b8277e1
Compare
ljharb
approved these changes
Nov 25, 2023
shadowspawn
force-pushed
the
feature/doc--no
branch
from
b8277e1
to
fb7c658
Compare
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.
As a light-weight approach I just added an example usage to the long example. I started to document
--no-fooexplicitly, but it felt disproportionate for a small feature against the rest of the documentation.Also, I removed old security warning. It has been quite a while since the original reports and fixes. I found it a bit stale and alarmist, but don't mind keeping it if preferred.
Fixes: #38