getsentry / getsentry/sentry-python
[linting] Require docstrings for all (public) methods
未关闭
Docs
Python
Quality Improvement
- 主要语言
- Python
- 星标
- 2.2k
- 派生
- 669
- 平均合并
- 1 天 1 小时
- 30 天内合并 PR
- 213
描述
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.
贡献指南
评估
这个 Issue 还没有评估数据。