getsentry / getsentry/sentry-python

[linting] Require docstrings for all (public) methods

Abierto
#3,719 1 comentario 0 reacciones 0 asignados Ver en GitHub
Docs Python Quality Improvement
Lenguaje dominante
Python
Estrellas
2.2k
Forks
669
Merge medio
1 d 1 h
PR fusionados (30 d)
213

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.