verl-project/verl

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

Chiusa

#1345 aperta il 30 apr 2025

Vedi su GitHubGuida contributor
 (2 commenti) (1 reazione) (0 assegnatari)Python (4426 fork)auto 404
call for contributiondocumentationenhancementgood first issue

Metriche repository

Star
 (23.023 stelle)
Metriche merge PR
 (Merge medio 3g 6h) (125 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Innanzitutto, esamina i formati di docstring esistenti nella codebase di verl per comprenderne lo stato attuale. Poi, ricerca lo standard di docstring NumPy come candidato per un formato unificato. Esamina strumenti automatizzati come pydocstyle o ruff per l'applicazione. L'issue non ha PR collegati e ha un commento; controlla quel commento per eventuali discussioni iniziali o preferenze. Pianifica di aggiornare i file in modo incrementale, iniziando con alcuni moduli per stabilire uno schema.
Tech stack
python
Dominio
documentationdeveloper experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Oltre 1 settimana
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonNumPy docstring standardCI/CD concepts
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65