docstring improvements
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 48/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Search for the docstrings of cf_xarray.bounds_to_vertices, vertices_to_bounds, shapely_to_cf, cf_to_shapely, and set_options, then compare them with the listed numpydoc warnings. Update the summaries, parameter and return documentation, See Also sections, and examples as applicable, and confirm that the reported validation warnings are resolved.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Would be good to clean up these warnings
WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.bounds_to_vertices':
SS06: Summary should fit in a single line
PR03: Wrong parameters order. Actual: ('bounds', 'bounds_dim', 'core_dims', 'order'). Documented: ('bounds', 'bounds_dim', 'order', 'core_dims')
SA01: See Also section not found
EX01: No examples section found
WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.vertices_to_bounds':
SS06: Summary should fit in a single line
RT03: Return value has no description
SA01: See Also section not found
EX01: No examples section found
WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.shapely_to_cf':
GL01: Docstring text (summary) should start in the line immediately after the opening quotes (not in the same line, or leaving a blank line in between)
SA01: See Also section not found
EX01: No examples section found
WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.cf_to_shapely':
GL01: Docstring text (summary) should start in the line immediately after the opening quotes (not in the same line, or leaving a blank line in between)
SA01: See Also section not found
EX01: No examples section found
WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.set_options':
GL01: Docstring text (summary) should start in the line immediately after the opening quotes (not in the same line, or leaving a blank line in between)
ES01: No extended summary found
PR01: Parameters {'**kwargs'} not documented
PR02: Unknown parameters {'custom_criteria', 'warn_on_missing_variables'}
SA01: See Also section not found
- Lingua principale
- Python
- Stelle
- 181
- Fork
- 49
- Merge medio
- 43m
- PR unite (30g)
- 1
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di xarray-contrib/cf-xarray
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
xarray-contrib/cf-xarray#623 ·
-
Consider adding opt-in support for circular axes when calling `bounds_to_vertices` (related to #594) Aperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 38/100
xarray-contrib/cf-xarray#596 · 1 commento ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 25/100
xarray-contrib/cf-xarray#570 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 15/100
xarray-contrib/cf-xarray#568 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
xarray-contrib/cf-xarray#566 · 2 commenti ·
Tutte le issue di xarray-contrib/cf-xarray
Issue simili
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
stephrobert/dsoxlab#238 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
sublimehq/package_control#1780 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
nwg-piotr/nwg-displays#145 ·