Docu: missing return values for Checker.check_all()
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 42/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- python
- Bereich
- documentation
Rechercherichtung
Beginne damit, Checker.check_all() in der einzigen Python-Quelldatei des Repositorys zu finden und sein Verhalten mit der ReadTheDocs-Dokumentation zu vergleichen. Dokumentiere die Argumente der Methode, den Rückgabewert und die ausgelösten Ausnahmen und prüfe anschließend, ob der entsprechende Quelltext und die ReadTheDocs-Einträge übereinstimmen. Als erledigt gilt die Aufgabe, wenn das Rückgabeverhalten für Benutzer klar ist und die relevante Dokumentation vollständig ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- Python
- Sterne
- 5.2k
- Forks
- 756
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus PyCQA/pycodestyle
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100
PyCQA/pycodestyle#1294 · 1 Kommentar ·
-
Typing and formattingOffen
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
PyCQA/pycodestyle#1302 · 3 Kommentare ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 42/100
PyCQA/pycodestyle#1242 · 2 Kommentare ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100
PyCQA/pycodestyle#1241 · 2 Kommentare · 4 Reaktionen ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100
PyCQA/pycodestyle#1217 ·
Alle Issues in PyCQA/pycodestyle
Ähnliche Issues
-
repo-audit
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
scverse/repo-health#20 ·
Maintainer antworten meist innerhalb von 1 Tag
-
/context/prime scope override double-prefixes an entity-ref project and drops its scoped memoriesOffen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
phasespace-labs/palinode#232 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
collective/icalendar#1858 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
Maintainer antworten meist innerhalb von 1 Tag
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
langflow-ai/langflow#15496 ·
Maintainer antworten meist innerhalb von 1 Tag