commandlineparser / commandlineparser/commandline

Formatting help text (ends of line)

Ouverte
#529 21 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
question
Langage dominant
C#
Étoiles
4.8k
Forks
478
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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` ?

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Commencez par HelpText.RenderUsageText et HelpText.RenderUsageTextAsLines, les points d’entrée mentionnés dans l’issue, et comparez leur sortie avec les exemples du command line wiki. Déterminez si les entrées d’aide peuvent utiliser un espacement avec une seule fin de ligne sans remplacer l’écran d’aide par défaut. C’est terminé lorsque le texte d’aide généré prend en charge le formatage single-EOL demandé et que sa sortie est vérifiée par rapport à l’exemple.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
csharp
Domaine
cli
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
38/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.