PyCQA/pydocstyle

Don't force to add docstrings to __new__

Aperta

#515 aperta il 22 ott 2020

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

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

Guida contributor

Direzione di ricerca
Inizia esaminando come pydocstyle gestisce attualmente i metodi magici come init e repr . Guarda il codice sorgente per D105 (docstring mancante nel metodo magico) e D107 (docstring mancante in init ). L'issue suggerisce che new dovrebbe essere trattato in modo simile a init . Potrebbe essere necessario aggiungere new all'elenco dei metodi esenti da D105 o creare un nuovo codice di errore. Controlla la logica esistente nelle funzioni di controllo e proponi una modifica. Inoltre, rivedi eventuali commenti correlati nell'issue per comprendere le preferenze dei manutentori.
Tech stack
python
Dominio
toolingdeveloper experience
Tipo issue
Bug
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