commandlineparser / commandlineparser/commandline

Formatting help text (ends of line)

Aberta
#529 21 comentários 0 reações 0 responsáveis Ver no GitHub
question
Linguagem predominante
C#
Estrelas
4.8k
Forks
478
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

The [command line wiki](https://github.com/commandlineparser/commandline/wiki) shows what help texts look like:

```
yourapp 2.0.201-alpha
[...]
--filename Input filename.

--help Display this help screen.

--version Display version information.
```
Each argument entry is followed by a **double end of line**. I wondered if there is a simple way to get a formatting with single eol, like this `grep` example:

```
Usage: grep [OPTION]... PATTERN [FILE]...
[...]
-E, --extended-regexp PATTERN is an extended regular expression (ERE)
-F, --fixed-strings PATTERN is a set of newline-separated strings
-G, --basic-regexp PATTERN is a basic regular expression (BRE)

```

If I undestand correctly, I'll have to implement [my own help screen](https://github.com/commandlineparser/commandline/wiki/Generating-Help-and-Usage-information#overriding-the-default-behavior) and use `HelpText.RenderUsageText` or `HelpText.RenderUsageTextAsLines` ?

Guia de contribuição

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

Direção de pesquisa

Comece com HelpText.RenderUsageText e HelpText.RenderUsageTextAsLines, os pontos de entrada mencionados na issue, e compare a saída deles com os exemplos do command line wiki. Determine se as entradas de ajuda podem usar espaçamento de uma única terminação de linha sem substituir a tela de ajuda padrão. Está concluído quando o texto de ajuda gerado der suporte à formatação single-EOL solicitada e sua saída tiver sido verificada em relação ao exemplo.

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
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
38/100

Receba novas issues na sua caixa de entrada

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