getsentry / getsentry/sentry-python

[linting] Require docstrings for all (public) methods

Aberta
#3,719 1 comentário 0 reações 0 responsáveis Ver no GitHub
Docs Python Quality Improvement
Linguagem predominante
Python
Estrelas
2.2k
Forks
669
Merge médio
1d 1h
PRs com merge (30d)
213

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.