PyCQA/pydocstyle

Add flag to ignore some functions, classes or class methods

Open

#537 opened on 2021年5月13日

GitHub で見る
 (1 comment) (4 reactions) (0 assignees)Python (1,106 stars) (191 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.