PyCQA/pydocstyle

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

开放

#516 创建于 2020年10月22日

在 GitHub 查看
 (0 条评论) (3 个反应) (0 位负责人)Python (191 个派生)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

仓库指标

星标
 (1,106 个星标)
PR 合并指标
 (30 天内没有已合并 PR)

描述

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

贡献者指南

研究方向
研究 pydocstyle 当前如何处理配置选项，例如查看 'config.py' 文件以及现有标志如 ' add ignore' 或 ' match'。理解 'pydocstyle/checker.py' 中的验证逻辑，查看公共/私有区分的执行位置。该功能请求要求添加一个标志以包含私有方法；一个良好的实现可能是添加一个 CLI 选项和相应的配置字段，然后修改验证循环，以便在标志设置时也检查私有成员。
技术栈
python
领域
documentation
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
PythonGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75