PyCQA/pydocstyle

Don't force to add docstrings to __new__

Open

#515 建立於 2020年10月22日

在 GitHub 查看
 (1 留言) (4 反應) (0 負責人)Python (191 fork)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

倉庫指標

Star
 (1,106 star)
PR 合併指標
 (30 天內沒有已合併 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 缺少文件字串）的原始碼。該問題建議 new 應被視為與 init 類似。你可能需要將 new 新增到免於 D105 檢查的方法列表中，或建立一個新的錯誤代碼。檢查檢查器函式中的現有邏輯並提出修改建議。此外，檢視問題中的任何相關評論以了解維護者的偏好。
技術棧
python
領域
toolingdeveloper experience
議題類型
錯誤
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Python
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70