PyCQA/pydocstyle

Don't force to add docstrings to __new__

Open

#515 建立於 2020年10月22日

在 GitHub 查看
 (1 留言) (4 反應) (0 負責人)Python (1,106 star) (191 fork)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
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.