PyCQA/pydocstyle

Add flag to ignore some functions, classes or class methods

Open

#537 创建于 2021年5月13日

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

描述

My problem

I document my class initialization inside the class docstring, therefore pydocstyle complains about undocumented __init__ methods.

My solution idea

It would be great to have the ability to have a flag (for example --ignore-func) that would work for both functions, classes and class methods with maybe a regex. So for ignoring the __init__ the flag could be --ignore-func='.*\.__init__', with .* for the class name, \. to say that it's a class method and __init__ to ignore that method.

贡献者指南

技术栈
python
领域
tooling
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic Pythonunderstanding of CLI argument parsingregex basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
35
研究方向
Investigate the existing CLI argument parsing in pydocstyle's main module (likely pydocstyle.py or similar) to understand how flags are added. Examine the docstring checking logic for functions and methods to see where the new ignore flag should be integrated. Since the issue lacked maintainer response, consider opening a discussion or comment to confirm the expected behavior and acceptance criteria.