search

minimistjs / minimist

parse argument options
MIT License
515 stars 30 forks source link

readme: add description of --no behaviour #48

Closed shadowspawn closed 5 months ago

shadowspawn commented 10 months ago

As a light-weight approach I just added an example usage to the long example. I started to document --no-foo explicitly, 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

codecov-commenter commented 10 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.78%. Comparing base (74f90f1) to head (fb7c658).

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #48 +/- ## ======================================= Coverage 98.78% 98.78% ======================================= Files 1 1 Lines 165 165 Branches 70 70 ======================================= Hits 163 163 Misses 2 2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

shadowspawn commented 9 months ago

After new discussion in #38, I think worth of some explanatory text in addition to the example.

shadowspawn commented 9 months ago

I (hopefully) matched the existing terminology and added a short description of a negated argument, in addition to --no-ding in the examples.