commandlineparser / commandlineparser/commandline

Extended help information

Aberta
#337 4 comentários 0 reações 0 responsáveis Ver no GitHub
enhancement good first issue
Linguagem predominante
C#
Estrelas
4.8k
Forks
478
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

I think that it would be nice if we could display additional text about application if someone types `MyApp --help`, and additional help for verb if someone types `MyApp Verb --help`.

I know there is `HelpText` property on `BaseAttribute`. It is nice for communicating what given option does, however I think that it is not suitable for extended, in-depth explanation. I would see it like that:

```
MyApp.exe help
MyApp 1.0.0
Copyright (C) 2018 MyApp

verb1 Help text for verb 1
verb2 Help text for verb 2
help Display more information on a specific command.
version Display version information.

Long explanation about app
```

```
MyApp.exe help verb1
MyApp 1.0.0
Copyright (C) 2018 MyApp

verb1 Help text for verb 1
verb2 Help text for verb 2
help Display more information on a specific command.
version Display version information.

Long explanation about verb1
```

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Direção de pesquisa

Comece lendo BaseAttribute e o comportamento existente da saída de ajuda. Determine como o texto estendido no nível da aplicação e no nível do verbo deve ser representado e exibido para os dois comandos de exemplo e, em seguida, verifique se ambas as formas de ajuda produzem as explicações longas solicitadas.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
csharp
Domínio
cli
Tipo de issue
Funcionalidade
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
30/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.