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# (421 forks)auto 404
Area-Helpbughelp wanted

Métricas do repositório

Stars
 (3.665 stars)
Métricas de merge de PR
 (Mesclagem média 1h 58m) (1 fundiu PR em 30d)

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

Direção de pesquisa
Encontre a lógica de renderização do texto de ajuda (provavelmente em uma classe como HelpBuilder) e adicione uma verificação condicional para pular a seção Descrição quando seu conteúdo for nulo ou vazio.
Pilha de tecnologia
csharp
Domain
cli
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.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitC#
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85