getsentry / getsentry/sentry-python

[linting] Require docstrings for all (public) methods

Aperta
#3,719 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Docs Python Quality Improvement
Lingua principale
Python
Stelle
2.2k
Fork
669
Merge medio
1g 40m
PR unite (30g)
212

Descrizione

All public API functions should be documented. To enforce this requirement, we should add a linter check that requires any newly-added functions to contain a docstring.

We should discuss whether it makes more sense to enforce docstrings for all functions or only public API functions. Having docstrings for private functions could help us remember what our internal functions are used for, but maybe we don't need to enforce this as a strict requirement.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.