Allow to disable requirement for uncapitalized descriptions #155
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This strict requirement makes sense only for programs designed for Fuchsia, no other system has this convention. This commit adds a type-level attribute `lax_description` that disables the option descriptions validation when present.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
jirutka
added a commit
to jirutka/argh
that referenced
this pull request
Jan 9, 2023
sadmac7000
requested changes
Oct 19, 2023
| @@ -6,7 +6,12 @@ use {argh::FromArgs, std::fmt::Debug}; | |||
|
|
|||
| #[derive(FromArgs, PartialEq, Debug)] | |||
| /// Top-level command. | |||
| #[argh(lax_descriptions)] | |||
There was a problem hiding this comment.
Seems like a weird place to add this to the example.
| /// Test that descriptions can start with any case when | ||
| /// the type attribute `lax_descriptions` is specified. | ||
| #[derive(FromArgs)] | ||
| #[argh(lax_descriptions)] |
There was a problem hiding this comment.
Not sure I like the name "lax_descriptions". Seems a bit generic.
| check_option_description(errors, d.content.value().trim(), d.content.span()); | ||
| if !type_attrs.lax_descriptions { | ||
| if let Some(d) = &this.description { | ||
| check_option_description(errors, d.content.value().trim(), d.content.span()); |
There was a problem hiding this comment.
I think we should change the behavior of check_option_description rather than skipping it entirely when the option is set.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This strict requirement makes sense only for programs designed for Fuchsia, no other system has this convention.
This commit adds a type-level attribute
lax_descriptionthat disables the option descriptions validation when present.