PyCQA/pydocstyle

Add flag to ignore some functions, classes or class methods

Open

#537 创建于 2021年5月13日

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

仓库指标

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

描述

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.

贡献者指南