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 (1,106 stars) (191 forks)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

説明

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).

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

技術スタック
python
領域
developer experiencetooling
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
knowledge of pydocstyle's D105 and D107 rulesfamiliarity with Python magic methods
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80
調査方針
Start by examining how pydocstyle currently handles magic methods like init and repr . Look at the source code for D105 (missing docstring in magic method) and D107 (missing docstring in init ). The issue suggests that new should be treated similarly to init . You may need to add new to the list of methods that are exempt from D105 or create a new error code. Check the existing logic in the checker functions and propose a modification. Additionally, review any related comments in the issue to understand maintainer preferences.