PyCQA/pydocstyle

Have a flag or config option to also include private methods/classes/etc in the verifications

Offen

#516 geöffnet am 22.10.2020

Auf GitHub ansehen
 (0 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)Python (191 Forks)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Repository-Metriken

Stars
 (1.106 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

This way all methods/classes/etc will be verified, not only public ones.

Contributor Guide

Research-Richtung
Untersuche, wie pydocstyle derzeit Konfigurationsoptionen behandelt, z.B. durch Betrachten der Datei 'config.py' und bestehender Flags wie ' add ignore' oder ' match'. Verstehe die Verifizierungslogik in 'pydocstyle/checker.py', um zu sehen, wo die Unterscheidung zwischen öffentlich/privat durchgesetzt wird. Die Feature Anfrage fordert ein Flag, um private Methoden einzuschließen; eine gute Implementierung könnte eine CLI Option und ein entsprechendes Konfigurationsfeld hinzufügen und dann die Verifizierungsschleife so ändern, dass auch private Mitglieder geprüft werden, wenn das Flag gesetzt ist.
Tech Stack
python
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75