PyCQA/pydocstyle

Don't force to add docstrings to __new__

Open

#515 opened on 2020年10月22日

GitHub で見る
 (1 comment) (4 reactions) (0 assignees)Python (191 forks)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Repository metrics

Stars
 (1,106 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

This should be considered a magic method (controlled by D105), or at least have a different error code (which may be D107 together with __init__ or even a new one).

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

調査方針
まず、pydocstyle が現在 init や repr のようなマジックメソッドをどのように扱っているかを調べてください。D105（マジックメソッドのドキュメント文字列欠落）と D107（ init のドキュメント文字列欠落）のソースコードを確認します。この issue は、 new が init と同様に扱われるべきであることを示唆しています。D105 の対象外となるメソッドのリストに new を追加するか、新しいエラーコードを作成する必要があるかもしれません。チェッカー関数内の既存のロジックを確認し、修正案を提案してください。さらに、メンテナの好みを理解するために、issue 内の関連コメントを確認してください。
技術スタック
python
領域
toolingdeveloper experience
Issue 種別
バグ
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Python
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70