docs: update Arg::default_missing_value description #5531
Conversation
|
I think that the clap is the easiest, best argument-parsing library I have ever used. Thank you for all that you all do to maintain it. I hope that this little documentation PR is helpful. I tried to follow all the procedures. Thank you, again! |
Fix minor grammatical error and reword for clarity.
hawkinsw
force-pushed
the
default_missing_value_docs
branch
from
9537fa7 to
c9ad502
Compare
| /// Configure a command-line argument that gives the user a shortcut and allows them to | ||
| /// efficiently select an option without requiring an explicit value. The `--color` |
There was a problem hiding this comment.
RE specify vs select
I feel like "select" would be "choosing an option from a drop down" while "specify" better connotes "write this out".
| @@ -1739,8 +1739,8 @@ impl Arg { | |||
|
|
|||
| /// Value for the argument when the flag is present but no value is specified. | |||
| /// | |||
| /// This configuration option is often used to give the user a shortcut and allow them to | |||
| /// efficiently specify an option argument without requiring an explicitly value. The `--color` | |||
| /// Configure a command-line argument that gives the user a shortcut and allows them to | |||
There was a problem hiding this comment.
Rather than giving an example of where this might be useful, this switches to more of an imperative tone that feels off putting. This would work better for a brief description but doesn't quite work for an example
| @@ -1739,8 +1739,8 @@ impl Arg { | |||
|
|
|||
| /// Value for the argument when the flag is present but no value is specified. | |||
| /// | |||
| /// This configuration option is often used to give the user a shortcut and allow them to | |||
| /// efficiently specify an option argument without requiring an explicitly value. The `--color` | |||
| /// Configure a command-line argument that gives the user a shortcut and allows them to | |||
There was a problem hiding this comment.
command-line argument
"command-line" is implied from context of this library and makes this overly verbose.
"option" is more specific than "argument" as this isn't as useful for positional arguments.
|
Thanks for wanting to help improve the docs! Looking forward to what comes out of our collaboration on this! |
Thank you for the quick reply! I am sorry that I didn't have time to spin another version of the PR tonight. I will incorporate your comments in a version that I hope I can get out tomorrow! Thank you again for the quick response! |
Fix minor grammatical error and reword for clarity.