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.