fix: omit empty help description section#2819
Closed
YNan-varamor wants to merge 2 commits into
Closed
Conversation
Author
|
@dotnet-policy-service agree |
Contributor
|
This is a duplicate of #2814. Before submitting a PR, it's helpful to check the issue in question to see whether other PRs are linked to it. |
Author
|
Closing this because it duplicates #2814. Thanks for pointing that out. |
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
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.
Summary
Omits the default help
Description:section when a command description is null, empty, or whitespace.Why
Fixes #2114. Descriptions are optional, but the default help layout always wrote a description heading. That produced an empty section such as:
Changes
falsewhen there is no description to renderValidation
git diff --checkI attempted to run:
but the local machine only has .NET SDK 10.0.203 and this repository's
global.jsoncurrently requests11.0.100-preview.4.26210.111, so the SDK could not be resolved.AI assistance disclosure
This PR was prepared with assistance from OpenAI Codex. The change was reviewed locally and kept to a focused bug fix with a regression test.