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.