dotnet/command-line-api

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

Open

#2.114 geöffnet am 22. März 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C# (3.665 Stars) (421 Forks)auto 404
Area-Helpbughelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
C# programming
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90
Research-Richtung
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.