Specify default values for all documented parameters

Aperta
  • Qualcosa non va?
#149 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Start with the function docstrings in the cf-plot Python package, using the width=0.02 example from the issue as a model. Look for parameters that default to None and get their real value from an if not <kwarg> check in the function body, and note each actual default. Done when every documented parameter states its default value in its docstring, matching what the code does.

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

Descrizione

docs enhancement

There is currently mostly no indication of default values for the documented parameters in the function docstrings, and though in some cases this can be implied by the function signature (e.g. width=0.02), this isn't often a clue since in lots of cases the defaults are set after an if not <kwarg> check for None values. As per good (and indeed expected) docstring practice these should be added so the user knows what default value is used by the logic.

Lingua principale
Python
Stelle
21
Fork
11
Merge medio
2g 21h
PR unite (30g)
7

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 NCAS-CMS/cf-plot

Tutte le issue di NCAS-CMS/cf-plot

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.