PyCQA/pydocstyle

Add flag to ignore some functions, classes or class methods

Offen

#537 geöffnet am 13.05.2021

Auf GitHub ansehen
 (1 Kommentar) (4 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

My problem

I document my class initialization inside the class docstring, therefore pydocstyle complains about undocumented __init__ methods.

My solution idea

It would be great to have the ability to have a flag (for example --ignore-func) that would work for both functions, classes and class methods with maybe a regex. So for ignoring the __init__ the flag could be --ignore-func='.*\.__init__', with .* for the class name, \. to say that it's a class method and __init__ to ignore that method.

Contributor Guide

Research-Richtung
Schauen Sie sich die Befehlszeilen Argumentanalyse von pydocstyle an (wahrscheinlich mit argparse oder ähnlich) und die Logik, die bestimmt, welche Docstrings überprüft werden. Implementieren Sie ein neues Befehlszeilen Flag, z. B. ignore func, das ein Regex Muster akzeptiert. Überspringen Sie dann beim Überprüfen von Funktionen, Klassen und Methoden diejenigen, deren qualifizierter Name dem Muster entspricht. Stellen Sie sicher, dass der Regex auf den vollständigen Punkt getrennten Namen angewendet wird (z. B. ClassName. init ). Fügen Sie Tests für die neue Funktion hinzu.
Tech Stack
python
Domain
tooling
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
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70