boostorg / boostorg/program_options

The short name is limited to 1 char

Ouverte
#96 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
C++
Étoiles
136
Forks
117
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Version 1.73.0

Documentation (https://www.boost.org/doc/libs/1_73_0/doc/html/boost/program_options/option_description.html#id-1_3_31_9_7_1_1_2_5-bb):

> The 'name' parameter is interpreted by the following rules:
> if there's no "," character in 'name', it specifies long name
> otherwise, the part before "," specifies long name and the part after -- short name.

Code, options_descriptions.cpp, line 205:
```
if (last_name.length() == 1) {
m_short_name = '-' + last_name;
m_long_names.pop_back();
```

This limitation is not mentioned in the docs.
I would prefer that short names of several characters are allowed, but otherwise the limitations should be at least mentioned.
Side note: the possibility of having several long names separated by colons is not mentioned there, either.

Guide de contribution

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

Piste de recherche

Commencez par options_descriptions.cpp à la ligne 205 et comparez la gestion des noms courts avec la documentation liée de option_description. Vérifiez comment sont décrits les noms contenant des virgules et des deux-points, puis mettez à jour la documentation pour qu’elle corresponde aux restrictions implémentées ou clarifiez le comportement demandé. Le travail est terminé lorsque les règles documentées couvrent correctement les noms courts et plusieurs noms longs.

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

Évaluation

Stack technique
cpp
Domaine
cli
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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