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

Conditionally trim trailing periods of argument and option descriptions #1740

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

TheTonttu
Copy link

fixes #1729

  • I have read the Contribution Guidelines
  • I have commented on the issue above and discussed the intended changes
  • A maintainer has signed off on the changes and the issue was assigned to me
  • All newly added code is adequately covered by tests
  • All existing tests are still running without errors
  • The documentation was modified to reflect the changes OR no documentation changes are required.

Changes

  • HelpProvider.TrimTrailingPeriod property affects trailing period of argument and option descriptions in addition to command descriptions.
  • Related test case output includes argument and option description in addition to command description.
    • The test case (Should_Not_Trim_Description_Trailing_Period) expectation text (Description_No_Trailing_Period) is a bit confusing/conflicting but I didn't touch it to keep changes minimal.
  • Localized print help and print version descriptions include trailing period.
    • Default help output stays the same but when the trimming is disabled the period is added to the output.

Please upvote 👍 this pull request if you are interested in it.

Changed the Should_Not_Trim_Description_Trailing_Period test case to output help with descriptions for command, argument, and option.
@TheTonttu
Copy link
Author

@microsoft-github-policy-service agree

@FrankRay78 FrankRay78 self-requested a review January 24, 2025 20:45
@FrankRay78 FrankRay78 added the area-CLI Command-Line Interface label Jan 24, 2025
@FrankRay78 FrankRay78 added this to the 0.50 milestone Jan 24, 2025
@FrankRay78
Copy link
Contributor

Thanks, I'll try to review this one over the weekend.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-CLI Command-Line Interface
Projects
Status: PR 📬
Development

Successfully merging this pull request may close these issues.

Inconsistent preserving of trailing period in help descriptions
2 participants