boostorg / boostorg/program_options

The short name is limited to 1 char

Offen
#96 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
C++
Sterne
136
Forks
117
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne bei options_descriptions.cpp in Zeile 205 und vergleiche die Verarbeitung von Kurznamen mit der verknüpften Dokumentation zu option_description. Prüfe, wie Namen mit Kommas und Doppelpunkten beschrieben werden, und aktualisiere anschließend die Dokumentation, sodass sie den implementierten Einschränkungen entspricht, oder stelle das gewünschte Verhalten klar. Erledigt ist die Aufgabe, wenn die dokumentierten Regeln Kurznamen und mehrere lange Namen korrekt abdecken.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
cpp
Bereich
cli
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.