bluerobotics / bluerobotics/ping-python
don't document 'private' members
オープン
- 主要言語
- Python
- スター
- 60
- フォーク
- 39
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Doxygen outputting a tad TMI.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
調査の方向性
まず、Doxygen の設定と、プロジェクトのドキュメント生成に使用されるエントリーポイントを見つけます。現在、private メンバーがどのように含まれているかを確認し、次に、再生成した Doxygen の出力で、public API のドキュメントを削除せずにそれらが除外されることを検証します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100