PyCQA/pydocstyle

Add flag to ignore some functions, classes or class methods

Aperta

#537 aperta il 13 mag 2021

Vedi su GitHub
 (1 commento) (4 reazioni) (0 assegnatari)Python (191 fork)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Metriche repository

Star
 (1106 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina l'analisi degli argomenti da riga di comando di pydocstyle (probabilmente usando argparse o simile) e la logica che determina quali docstring controllare. Implementa un nuovo flag da riga di comando, ad esempio ignore func, che accetta un pattern regex. Quindi, quando controlli funzioni, classi e metodi, salta quelli il cui nome qualificato corrisponde al pattern. Assicurati che la regex sia applicata al nome completo con punti (es. ClassName. init ). Fornisci test per la nuova funzionalità.
Tech stack
python
Dominio
tooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70