PyCQA/pydocstyle

Don't force to add docstrings to __new__

Offen

#515 geöffnet am 22.10.2020

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

This should be considered a magic method (controlled by D105), or at least have a different error code (which may be D107 together with __init__ or even a new one).

Contributor Guide

Research-Richtung
Beginnen Sie damit zu untersuchen, wie pydocstyle derzeit magische Methoden wie init und repr behandelt. Sehen Sie sich den Quellcode für D105 (fehlende Docstring in magischer Methode) und D107 (fehlende Docstring in init ) an. Das Issue legt nahe, dass new ähnlich wie init behandelt werden sollte. Möglicherweise müssen Sie new zur Liste der von D105 ausgenommenen Methoden hinzufügen oder einen neuen Fehlercode erstellen. Überprüfen Sie die vorhandene Logik in den Prüffunktionen und schlagen Sie eine Änderung vor. Überprüfen Sie außerdem alle relevanten Kommentare im Issue, um die Präferenzen der Maintainer zu verstehen.
Tech Stack
python
Domain
toolingdeveloper experience
Issue Type
Fehler
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