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 (191 forks)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Repository metrics

Stars
 (1,106 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Examine how pydocstyle currently handles magic methods like init (D107) and new is not excluded. Check if D105 should include new or a new error code should be created. Look at the code base for the decorator or list that defines magic methods.
Tech stack
python
Domain
toolingdeveloper experience
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70