dotnet/command-line-api

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

Open

Aperta il 22 mar 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)C# (3665 star) (421 fork)auto 404
Area-Helpbughelp wanted

Descrizione

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

Guida contributor

Tech stack
csharp
Dominio
clideveloper experience
Tipo issue
bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
under 1 hour
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
C# programming
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90
Direzione di ricerca
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.