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