dotnet/command-line-api

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

Open

#2 114 ouverte le 22 mars 2023

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)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

Guide contributeur

Stack technique
csharp
Domaine
clideveloper experience
Type d'issue
bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
C# programming
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90
Direction de recherche
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.