search

clap-rs / clap

A full featured, fast Command Line Argument Parser for Rust
docs.rs/clap
Apache License 2.0
13.65k stars 1.02k forks source link

Update doctring for BoolishValueParser::new #5474

Closed Will-Low closed 2 months ago

Will-Low commented 2 months ago

There seems to be an inconsistency between the docstring and the behavior of BoolishValueParser::new(). The docstring makes it seem as if a non-boolish value will default to true. This is not the case. Instead, an error occurs during parsing, which can be seen in the example code for BoolishValueParser.

Updating the docstring to align with current behavior.

epage commented 2 months ago

Yeah, looks like this was copy/paste from Falsey