getsentry / getsentry/sentry-python
[linting] Require docstrings for all (public) methods
未關閉
Docs
Python
Quality Improvement
- 主要語言
- Python
- 星號
- 2.2k
- 分支
- 669
- 平均合併
- 1 天 40 分鐘
- 30 天內合併 PR
- 212
描述
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 還沒有評估資料。