PyCQA/pydocstyle

Add flag to ignore some functions, classes or class methods

Ouverte

#537 ouverte le 13 mai 2021

Voir sur GitHub
 (1 commentaire) (4 réactions) (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

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.

Guide contributeur

Direction de recherche
Examinez l'analyse des arguments en ligne de commande de pydocstyle (probablement en utilisant argparse ou similaire) et la logique qui détermine quelles docstrings vérifier. Implémentez un nouveau drapeau de ligne de commande, par exemple ignore func, qui accepte un motif regex. Ensuite, lors de la vérification des fonctions, classes et méthodes, ignorez celles dont le nom qualifié correspond au motif. Assurez vous que la regex est appliquée au nom complet avec points (ex. ClassName. init ). Fournissez des tests pour la nouvelle fonctionnalité.
Stack technique
python
Domaine
tooling
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.
1-3 heures
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
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70