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: update Arg::default_missing_value description #5531

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hawkinsw
Copy link

Fix minor grammatical error and reword for clarity.

@hawkinsw
Copy link
Author

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.
Comment on lines +1742 to +1743
/// 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`
Copy link
Member

Choose a reason for hiding this comment

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

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
Copy link
Member

Choose a reason for hiding this comment

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

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
Copy link
Member

Choose a reason for hiding this comment

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

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.

@epage
Copy link
Member

epage commented Jun 12, 2024

Thanks for wanting to help improve the docs! Looking forward to what comes out of our collaboration on this!

@hawkinsw
Copy link
Author

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!
Will

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants