verl-project/verl

[FR][Dev] Unify (& Complete) the docstring format

クローズ

#1,345 opened on 2025/04/30

GitHub で見るコントリビューターガイド
 (2 件のコメント) (1 件のリアクション) (0 人の担当者)Python (4,427 件のフォーク)auto 404
call for contributiondocumentationenhancementgood first issue

Repository metrics

Stars
 (23,038 個のスター)
PR merge metrics
 (平均マージ 3d 6h) (30d で 125 merged PRs)

説明

Motivation

Many docstrings in verl are missing, incomplete or in a messy format.

We might want to adopt a unified format (and complete them), better with automatic checking.

Plan

  • Choose a docstring standard (e.g., NumPy).
  • Unify the format.
  • Add automatic checking.
  • Complete all the docstrings.

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

調査方針
まず、verl コードベース内の既存の docstring フォーマットを調べて、現在の状態を理解します。次に、統一フォーマットの候補として NumPy docstring 標準を調査します。pydocstyle や ruff などの自動化ツールを調査して、強制実行を検討します。この issue には関連する PR はなく、1 件のコメントがあります。そのコメントを確認して、初期の議論や好みがあるかどうかを確認してください。パターンを確立するために、いくつかのモジュールから始めて、ファイルを段階的に更新する計画を立てます。
技術スタック
python
領域
documentationdeveloper experience
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1週間超
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
PythonNumPy docstring standardCI/CD concepts
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65