airo-ugent / airo-ugent/airo-mono

add docstring validation to CI

Aperta
#14 1 commento 0 reazioni 1 assegnatario Rivendicata da @tlpss Vedi su GitHub
enhancement
Lingua principale
Python
Stelle
32
Fork
8
Merge medio
8m
PR unite (30g)
4

Descrizione

ideally would check that docstring
- is available
- adheres to google docstring format
- matches the function arguments and defines all of them (so that after refactoring you get a complaint that the docstring is no longer okay)

https://github.com/PyCQA/pydocstyle does (some of) this

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.