boostorg / boostorg/program_options

The short name is limited to 1 char

オープン
#96 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
C++
スター
136
フォーク
117
PR マージ指標
30日以内にマージされた PR はありません

説明

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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

options_descriptions.cpp の205行目から始め、短い名前の扱いを、リンク先の option_description のドキュメントと比較してください。コンマやコロンを含む名前がどのように説明されているかを確認し、実装されている制限に合うようにドキュメントを更新するか、要求されている動作を明確にしてください。短い名前と複数の長い名前を、ドキュメント化された規則が正確にカバーしていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
cpp
領域
cli
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。