Docstrings for public APIs in `meridian.runtime`

Aperta
#124 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
76/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Read CONTRIBUTING.md, then inspect the public classes, methods, and functions under src/meridian/runtime/ and use nearby docstrings as examples. Run uv run ruff check src/meridian/runtime --select D101,D102,D103 to find missing docstrings; add a one-line description for each. Done when that command reports no issues.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

area: runtime documentation good first issue size: S
Context

ruff's pydocstyle rules find about 48 public classes, methods and functions in src/meridian/runtime/ with no docstring.

What to do

Add one-line docstrings saying what each does (the surrounding code has good examples).

Done when

uv run ruff check src/meridian/runtime --select D101,D102,D103 is clean.

Where to look

src/meridian/runtime/


New here? Read CONTRIBUTING.md and comment on this issue to say you are taking it.


Generated by Claude Code

Lingua principale
Python
Stelle
0
Fork
0
Merge medio
1h 54m
PR unite (30g)
14

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di patsypppe/meridian

Tutte le issue di patsypppe/meridian

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.