dotnet/command-line-api

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

Open

#2.114 aberto em 22 de mar. de 2023

Ver no 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

Guia do colaborador

Pilha de tecnologia
csharp
Domain
clideveloper experience
Tipo Issue
bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
under 1 hour
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
C# programming
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90
Direção de pesquisa
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.