EducationalTestingService / EducationalTestingService/rsmtool

Rewrite docstrings to match scikit-learn Style

オープン
#491 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
documentation enhancement help wanted
主要言語
Python
スター
71
フォーク
21
PR マージ指標
30日以内にマージされた PR はありません

説明

We should try and match the way that scikit-learn writes their docstrings. [Here](https://github.com/scikit-learn/scikit-learn/blob/master/sklearn/linear_model/_huber.py#L125) is an example.

For example, there is a blank line between the parameters and the default values are indicated right after the parameter type. It's also nice how the types that are numpy arrays also include the shapes.

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

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

調査の方向性

ファイルやテストは指定されていません。まずプロジェクトの Python docstring を見つけ、リンク先の scikit-learn の例と比較します。パラメーターの間隔、デフォルト値、NumPy 配列の shape を含めて比較し、関連する docstring が一貫してそのスタイルに従っていれば完了です。

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

評価

技術スタック
python, scikit-learn
領域
documentation
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
28/100

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

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