PyCQA/pydocstyle

Add flag to ignore some functions, classes or class methods

Open

#537 opened on May 13, 2021

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

My problem

I document my class initialization inside the class docstring, therefore pydocstyle complains about undocumented __init__ methods.

My solution idea

It would be great to have the ability to have a flag (for example --ignore-func) that would work for both functions, classes and class methods with maybe a regex. So for ignoring the __init__ the flag could be --ignore-func='.*\.__init__', with .* for the class name, \. to say that it's a class method and __init__ to ignore that method.

Contributor guide

Tech stack
python
Domain
tooling
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.
1-2 days
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
basic Pythonunderstanding of CLI argument parsingregex basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate the existing CLI argument parsing in pydocstyle's main module (likely pydocstyle.py or similar) to understand how flags are added. Examine the docstring checking logic for functions and methods to see where the new ignore flag should be integrated. Since the issue lacked maintainer response, consider opening a discussion or comment to confirm the expected behavior and acceptance criteria.