PyCQA/pydocstyle

Support a new rule: no blank line after last docstring section

Aperta

#530 aperta il 1 apr 2021

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

D413 says "Missing blank line after last section". It'd be awesome to have the opposite, and raise a new warning when there is a blank line at the end of a docstring. Using Google style, there shouldn't be an empty line at the end, so a warning should exist for this case.

Thank you for your consideration!

Guida contributor

Direzione di ricerca
Implementa una nuova regola simile a D413 ma inversa: controlla se c'è una riga vuota dopo l'ultima sezione in una docstring in stile Google. Studia la regola D413 esistente nel codice sorgente di pydocstyle per comprendere lo schema, aggiungi il nuovo controllo nel modulo appropriato, scrivi test e aggiorna la documentazione.
Tech stack
python
Dominio
developer experiencetoolingtesting qa
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
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.
65