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