PyCQA/pydocstyle

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

Ouverte

#530 ouverte le 1 avr. 2021

Voir sur GitHub
 (3 commentaires) (1 réaction) (0 personne assignée)Python (191 forks)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Métriques du dépôt

Stars
 (1 106 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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!

Guide contributeur

Direction de recherche
Implémentez une nouvelle règle similaire à D413 mais inverse : vérifiez s'il y a une ligne vide après la dernière section dans une docstring de style Google. Étudiez la règle D413 existante dans le code source de pydocstyle pour comprendre le modèle, ajoutez la nouvelle vérification dans le module approprié, écrivez des tests et mettez à jour la documentation.
Stack technique
python
Domaine
developer experiencetoolingtesting qa
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65