PyCQA/pydocstyle

Don't force to add docstrings to __new__

Open

#515 opened on Oct 22, 2020

View on GitHub
 (1 comment) (4 reactions) (0 assignees)Python (1,106 stars) (191 forks)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Description

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

Contributor guide

Tech stack
python
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
knowledge of pydocstyle's D105 and D107 rulesfamiliarity with Python magic methods
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.