verl-project/verl

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

Closed

#1,345 opened on Apr 30, 2025

View on GitHubContributor guide
 (2 comments) (1 reaction) (0 assignees)Python (4,422 forks)auto 404
call for contributiondocumentationenhancementgood first issue

Repository metrics

Stars
 (23,003 stars)
PR merge metrics
 (Avg merge 3d 6h) (125 merged PRs in 30d)

Description

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.

Contributor guide

Research direction
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.
Tech stack
python
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonNumPy docstring standardCI/CD concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65