Augment and correct the Option.HelpName API docs #2687
Merged
Conversation
This file contains hidden or 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
jonsequitur
approved these changes
Sep 26, 2025
adamsitnik
reviewed
Sep 29, 2025
There was a problem hiding this comment.
It looks great, but could you please apply similar changes to Argument.HelpName as well?
command-line-api/src/System.CommandLine/Argument.cs
Lines 47 to 50 in 2464766
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.
Fixes #2594
We entertained renaming the member but did not arrive an a name improvement that justified making a breaking change at this stage. Instead of renaming, this PR augments and corrects the API docs (and therefore IntelliSense) to make the member's purpose clearer.
We intend to backport this fix into
release/10.0.