verl-project/verl

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

已關閉

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

在 GitHub 查看貢獻者指南
 (2 則留言) (1 個反應) (0 位負責人)Python (4,440 個分叉)auto 404
call for contributiondocumentationenhancementgood first issue

倉庫指標

星標
 (23,087 顆星)
PR 合併指標
 (平均合併 3天 6小時) (30 天內合併 125 個 PR)

描述

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 程式碼庫中現有的文件字串格式，以了解當前狀態。然後，研究 NumPy 文件字串標準作為統一格式的候選方案。調研 pydocstyle 或 ruff 等自動化工具以進行強制執行。該問題沒有關聯的 PR，且有一條評論；請查看該評論以了解任何初步討論或偏好。計劃逐步更新文件，從幾個模組開始以建立模式。
技術棧
python
領域
documentationdeveloper experience
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
超過 1 週
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
新近可參與
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
PythonNumPy docstring standardCI/CD concepts
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
65