dotnet/command-line-api

When Description is empty, the description section should be ommitted from help.

Open

#2,114 opened on Mar 22, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C# (3,665 stars) (421 forks)auto 404
Area-Helpbughelp wanted

Description

Per title. For an empty description, the help currently shows:

Description:

The API treats descriptions as optional (string?), so the help should do too.

cc @adamsitnik @jonsequitur

Contributor guide

Tech stack
csharp
Domain
clideveloper experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C# programming
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue involves modifying the help rendering logic to omit the Description section when the description is empty. Look for files like HelpBuilder.cs or similar classes that generate help text. The fix likely requires checking if the description is null or empty and conditionally not rendering that section.