PyCQA/pydocstyle

Have a flag or config option to also include private methods/classes/etc in the verifications

Open

#516 opened on Oct 22, 2020

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

Description

This way all methods/classes/etc will be verified, not only public ones.

Contributor guide

Tech stack
python
Domain
toolingdeveloper experience
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-3 hours
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 knowledge of pydocstyle configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate how pydocstyle currently handles configuration options, e.g., by looking at the 'config.py' file and existing flags like ' add ignore' or ' match'. Understand the verification logic in 'pydocstyle/checker.py' to see where public/private distinction is enforced. The feature request asks for a flag to include private methods; a good implementation might add a CLI option and corresponding configuration field, then modify the verification loop to also check private members when the flag is set.