PyCQA/pydocstyle

Support a new rule: no blank line after last docstring section

Offen

#530 geöffnet am 01.04.2021

Auf GitHub ansehen
 (3 Kommentare) (1 Reaktion) (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

D413 says "Missing blank line after last section". It'd be awesome to have the opposite, and raise a new warning when there is a blank line at the end of a docstring. Using Google style, there shouldn't be an empty line at the end, so a warning should exist for this case.

Thank you for your consideration!

Contributor Guide

Research-Richtung
Implementieren Sie eine neue Regel ähnlich wie D413, aber umgekehrt: Prüfen Sie auf eine Leerzeile nach dem letzten Abschnitt in einem Docstring im Google Stil. Studieren Sie die bestehende Regel D413 im pydocstyle Quellcode, um das Muster zu verstehen, fügen Sie die neue Prüfung im entsprechenden Modul hinzu, schreiben Sie Tests und aktualisieren Sie die Dokumentation.
Tech Stack
python
Domain
developer experiencetoolingtesting qa
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.
Halber Tag
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.
65