Fix empty description help section#2814
Closed
marko1olo wants to merge 2 commits into
Closed
Conversation
jonsequitur
reviewed
Jun 5, 2026
jonsequitur
reviewed
Jun 5, 2026
marko1olo
force-pushed
the
fix-empty-description-help
branch
from
June 8, 2026 18:03
7ac030b to
7829e69
Compare
jonsequitur
approved these changes
Jun 8, 2026
Contributor
|
@marko1olo This PR can be merged once you've accepted the CLA. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 #2114.
This suppresses the default help
Description:section when the command description is null, empty, or whitespace. Descriptions are optional, so help output should not render an empty section.Changes:
SynopsisSection()now returnsfalsefor null/empty/whitespace descriptions.Description:section.Validation:
git diff --checkNot run locally:
dotnet testforSystem.CommandLine.Testshelp tests.Reason: current machine CPU stayed above the local process gate threshold, so I did not start a .NET test/build process. The change is small and covered by added/updated tests in this PR.