verl-project/verl

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

Open

#1,345 建立於 2025年4月30日

在 GitHub 查看
 (1 留言) (1 反應) (0 負責人)Python (21,533 star) (3,940 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
over 1 week
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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