NCAS-CMS / NCAS-CMS/cf-python

Address API documentation summary line TODOs

Aperta
#243 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Python
Stelle
150
Fork
23
Merge medio
1g 11h
PR unite (30g)
2

Descrizione

All methods should at least have a summary line to outline their basic purpose or usage. Currently this is not the case leaving the rationale for methods such as Field.get_coordinate_reference (as noted in #239) potentially unclear.

As a crude estimate of the number of methods undocumented minimally, git grep '"""TODO' | wc -l under the cf/ dir gives 99 for the state of the codebase at time of making this comment (with the equivalent for "'''TODO" not required as black enforces double-quote marks for docstrings etc.). So ~100 methods need summarising. That's small enough to tackle for the next release, easily.

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Inizia nella directory cf/ eseguendo git grep '\"\"\"TODO' | wc -l per individuare i metodi privi di docstring riepilogative. Leggi ogni metodo interessato, incluso Field.get_coordinate_reference, per comprenderne lo scopo di base e l'utilizzo. Il lavoro è completato quando le docstring TODO contengono righe di riepilogo concise e il conteggio rimanente è stato gestito.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.