verl-project/verl

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

Open

#1,345 opened on 2025年4月30日

GitHub で見る
 (1 comment) (1 reaction) (0 assignees)Python (21,533 stars) (3,940 forks)auto 404
call for contributiondocumentationenhancementgood first issue

説明

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.

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

技術スタック
python
領域
documentationdeveloper experience
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
over 1 week
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
PythonNumPy docstring standardCI/CD concepts
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65
調査方針
First, examine the existing docstring formats in the verl codebase to understand the current state. Then, research the NumPy docstring standard as a candidate for unified format. Look into automated tools such as pydocstyle or ruff for enforcement. The issue has no linked PRs and one comment; check that comment for any initial discussion or preferences. Plan to update files incrementally, starting with a few modules to establish a pattern.
[FR][Dev] Unify (& Complete) the docstring format · verl-project/verl#1345 | Good First Issue