PyCQA/pydocstyle

Don't force to add docstrings to __new__

Ouverte

#515 ouverte le 22 oct. 2020

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

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).

Guide contributeur

Direction de recherche
Commencez par examiner comment pydocstyle gère actuellement les méthodes magiques comme init et repr . Consultez le code source pour D105 (docstring manquante dans une méthode magique) et D107 (docstring manquante dans init ). L'issue suggère que new devrait être traité de manière similaire à init . Vous devrez peut être ajouter new à la liste des méthodes exemptées de D105 ou créer un nouveau code d'erreur. Vérifiez la logique existante dans les fonctions de vérification et proposez une modification. De plus, examinez tous les commentaires associés dans l'issue pour comprendre les préférences des mainteneurs.
Stack technique
python
Domaine
toolingdeveloper experience
Type d'issue
Bug
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