PyCQA/pydocstyle

Have a flag or config option to also include private methods/classes/etc in the verifications

Open

#516 创建于 2020年10月22日

在 GitHub 查看
 (0 评论) (3 反应) (0 负责人)Python (1,106 star) (191 fork)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

描述

This way all methods/classes/etc will be verified, not only public ones.

贡献者指南

技术栈
python
领域
toolingdeveloper experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic knowledge of pydocstyle configuration
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Investigate how pydocstyle currently handles configuration options, e.g., by looking at the 'config.py' file and existing flags like ' add ignore' or ' match'. Understand the verification logic in 'pydocstyle/checker.py' to see where public/private distinction is enforced. The feature request asks for a flag to include private methods; a good implementation might add a CLI option and corresponding configuration field, then modify the verification loop to also check private members when the flag is set.