statsmodels/statsmodels

DOC: docstrings in robust.norms, improve, reorganize

クローズ

#8,807 opened on 2023/04/17

GitHub で見るコントリビューターガイド
 (11 件のコメント) (0 件のリアクション) (0 人の担当者)Python (2,831 件のフォーク)batch import
comp-docscomp-robustgood first issue

Repository metrics

Stars
 (9,176 個のスター)
PR merge metrics
 (平均マージ 3d) (30d で 45 merged PRs)

説明

The docstrings for methods in robust norm have the formulas in the Returns section.

Would be better before Parameter section as extended description. Also converting to math will look better if we can get table formatting of equations (align for z ... in piecewise functions)

コントリビューターガイド

調査方針
statsmodels の robust.norms モジュールに焦点を当てます。そのモジュール内のメソッドの既存の docstring を確認し、数式の現在の配置を理解します。この課題では、数式を Returns セクションから Parameters セクションの前の拡張説明に移動し、特に区分的関数の可読性を向上させるために数式フォーマットを使用することを求めています。リポジトリが :math: ロール付きの reStructuredText または LaTeX 数式を使用しているか確認します。さらなるガイダンスについては、課題内のコメントを確認してください。
技術スタック
python
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Python docstring conventionsreStructuredText basics
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90