PyCQA/pydocstyle

Add flag to ignore some functions, classes or class methods

オープン

#537 opened on 2021/05/13

GitHub で見る
 (1 件のコメント) (4 件のリアクション) (0 人の担当者)Python (191 件のフォーク)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Repository metrics

Stars
 (1,106 個のスター)
PR merge metrics
 (30d に merged 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.

コントリビューターガイド

調査方針
pydocstyleのコマンドライン引数解析（おそらくargparseなど）と、どのdocstringをチェックするかを決定するロジックを調べてください。新しいコマンドラインフラグ（例： ignore func）を実装し、正規表現パターンを受け付けるようにします。その後、関数、クラス、メソッドをチェックする際に、完全修飾名がパターンに一致するものはスキップします。正規表現は完全なドット区切り名（例：ClassName. init ）に適用されることを確認します。新機能のテストを提供してください。
技術スタック
python
領域
tooling
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Python
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70