Make docstrings to be nice with pydoc
オープン
まだ誰も着手していません。
documentation
- 主要言語
- Python
- スター
- 1.7k
- フォーク
- 408
- 平均マージ
- 2日 57分
- マージ済み PR(30日)
- 7
説明
In some doc-strings we use formatting rules specific to Sphinx, but which make the interactive help (pydoc) to look bad.
This issue is about:
- defining how we should write some recurrent stuff, like documenting input parameters and return values.
- rewrite the doc-strings so they look fine on pydoc, even if that means losing some features with Sphinx, like cross references.
Note. If we had the resources, we would do like Python does, and document things twice: once in the doc-strings and a feature rich version in the rst files. But in any case the doc-strings must be usable with pydoc, so lets start with that.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
ファイル、テスト、エントリーポイントは指定されていません。まずプロジェクトのdocstringsを一覧化し、pydocでレンダリングした出力をSphinxの規約と比較します。完了の条件は、繰り返し登場するパラメーターと戻り値について合意された書式規則があり、かつdocstringsがpydocで引き続き利用できる形に書き直されていることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 25/100