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 (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 way all methods/classes/etc will be verified, not only public ones.

Contributor guide

Research direction
Examine the pydocstyle configuration system and add a new flag or config option to enable verification of private methods/classes. Look at existing flag implementations as a template.
Tech stack
python
Domain
documentation
Issue type
Feature
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
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75