Docstrings for the remaining packages, then turn the rule on

Aperta
#127 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à
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
testing, tooling

Direzione di ricerca

Read CONTRIBUTING.md and inspect the remaining public APIs in config.py, adapters/, importers/, store/, gate/, suites/ and snapshots/ to identify the missing docstrings. Then update the select list in pyproject.toml to enable pydocstyle D1 rules and run the project’s Ruff checks. Done when Ruff enforces public API docstrings in CI.

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

Descrizione

documentation good first issue size: S
Context

After the runtime, models, grading and manifest issues, about 35 items remain in config.py, adapters/, importers/, store/, gate/, suites/ and snapshots/.

What to do

Add them, then enable the pydocstyle D1 rules in pyproject.toml so new code keeps docstrings.

Done when

ruff enforces docstrings on public APIs in CI.

Where to look

pyproject.toml ([tool.ruff.lint] select)


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.