PyCQA/pydocstyle

Have a flag or config option to also include private methods/classes/etc in the verifications

Ouverte

#516 ouverte le 22 oct. 2020

Voir sur GitHub
 (0 commentaire) (3 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

This way all methods/classes/etc will be verified, not only public ones.

Guide contributeur

Direction de recherche
Étudiez comment pydocstyle gère actuellement les options de configuration, par exemple en examinant le fichier 'config.py' et les drapeaux existants comme ' add ignore' ou ' match'. Comprenez la logique de vérification dans 'pydocstyle/checker.py' pour voir où la distinction public/privé est appliquée. La demande de fonctionnalité demande un drapeau pour inclure les méthodes privées ; une bonne implémentation pourrait ajouter une option CLI et un champ de configuration correspondant, puis modifier la boucle de vérification pour également vérifier les membres privés lorsque le drapeau est défini.
Stack technique
python
Domaine
documentation
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
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75