Docu: missing return values for Checker.check_all()
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 42/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Inizia individuando Checker.check_all() nell’unico file sorgente Python del repository e confronta il suo comportamento con la documentazione di ReadTheDocs. Documenta gli argomenti del metodo, il valore restituito e le eccezioni sollevate, quindi verifica se il codice sorgente corrispondente e le voci di ReadTheDocs concordano. Il lavoro è completato quando il comportamento del valore restituito è chiaro agli utenti e la documentazione pertinente è completa.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
The docu on source and on readthedocs is unclear about if and what Checker.check_all() returns.
Of course I can read the source and find the answer. But it would easier for all users if all classes and methods would provide a full documentation in the docstring on all arguments, return values and raised exceptions.
- Lingua principale
- Python
- Stelle
- 5.2k
- Fork
- 754
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
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 PyCQA/pycodestyle
-
DOC: E252 is not documentedAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100
PyCQA/pycodestyle#1294 · 1 commento ·
-
Typing and formattingAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
PyCQA/pycodestyle#1302 · 3 commenti ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 42/100
PyCQA/pycodestyle#1242 · 2 commenti ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 68/100
PyCQA/pycodestyle#1241 · 2 commenti · 4 reazioni ·
-
`exclude` is applied to `.`Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
PyCQA/pycodestyle#1217 ·
Tutte le issue di PyCQA/pycodestyle
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
letsencrypt/cp-cps#353 ·
-
Marble Madness II is missingAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
PedestrianDynamics/pyFDS-Evac#394 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
DOI-USGS/pywatershed#421 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
python-pillow/Pillow#10087 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno