TheAlgorithms / TheAlgorithms/Python
Suggestion: adopt a documentation format for docstring
オープン
まだ誰も着手していません。
awaiting reviews
- 主要言語
- Python
- スター
- 225k
- フォーク
- 51.1k
- 平均マージ
- 1日 23時間
- マージ済み PR(30日)
- 156
説明
As the number of algorithms are increasing, it might make sense to adopt a single documentation format for docstrings. Following are existing currently:
- Google Docstring: https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings
- Numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
- Sphinx: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html
There are editor extensions which help in generating the docstring based on the chosen format like:
The doctest will come under the examples section for each of the above format.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、issue にリンクされている Google Docstring、Numpydoc、Sphinx の各形式を比較し、それぞれが doctest の例をどのように扱うかも確認します。プロジェクトが形式を選択したかどうかを判断するため、議論を確認します。合意されたドキュメント形式と、それをアルゴリズムの docstring 全体に適用する定義済みの方法があれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 活発
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100