PyCQA/pydocstyle

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

Aperta

#516 aperta il 22 ott 2020

Vedi su GitHub
 (0 commenti) (3 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

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

Guida contributor

Direzione di ricerca
Indaga come pydocstyle gestisce attualmente le opzioni di configurazione, ad esempio esaminando il file 'config.py' e i flag esistenti come ' add ignore' o ' match'. Comprendi la logica di verifica in 'pydocstyle/checker.py' per vedere dove viene applicata la distinzione pubblico/privato. La richiesta di funzionalità chiede un flag per includere i metodi privati; una buona implementazione potrebbe aggiungere un'opzione CLI e un corrispondente campo di configurazione, quindi modificare il ciclo di verifica per controllare anche i membri privati quando il flag è impostato.
Tech stack
python
Dominio
documentation
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
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75