Docstrings for `grading` and `manifest`

Aperta Adatta ai principianti
  • Qualcosa non va?
#126 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à
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
85/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia leggendo gli elementi pubblici in src/meridian/grading/ e src/meridian/manifest/, poi esegui il comando Ruff indicato nell’issue per individuare i docstring mancanti. Aggiungi docstring agli elementi segnalati e riesegui il comando; il lavoro è terminato quando non segnala più violazioni D101, D102 o D103.

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

Descrizione

area: grading documentation good first issue size: S
Context

About 30 public items in src/meridian/grading/ and src/meridian/manifest/ have no docstring.

What to do

Add them.

Done when

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

Where to look

src/meridian/grading/, src/meridian/manifest/

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.