getsentry / getsentry/sentry-python
[linting] Require docstrings for all (public) methods
Đang mở
Docs
Python
Quality Improvement
- Ngôn ngữ chính
- Python
- Star
- 2.2k
- Fork
- 669
- Merge trung bình
- 1 ngày 1 giờ
- Pull request đã merge (30 ngày)
- 213
Mô tả
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.
Hướng dẫn đóng góp
Đánh giá
Issue này chưa được đánh giá.