Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs]: Document and test boolean options consuming true/false strings #74

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

shadowspawn
Copy link
Collaborator

An undocumented feature is that explicit boolean options consume arguments which are the strings true or false. This leads to surprise when people discover the behaviour. Leaving aside whether the behaviour is a good idea, at least document it!

Fixes #64

Copy link
Member

@ljharb ljharb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@shadowspawn shadowspawn force-pushed the document-true-false-consumption branch from 5f82e2e to 11303eb Compare January 22, 2025 22:30
@ljharb ljharb added the documentation Improvements or additions to documentation label Jan 22, 2025
@ljharb ljharb merged commit 11303eb into minimistjs:main Jan 22, 2025
13 checks passed
@shadowspawn shadowspawn deleted the document-true-false-consumption branch January 25, 2025 00:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Boolean argument detection is too aggressive
2 participants