Is it possible to skip specific rules for specific functions?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
Hi all. Is it possible to skip specific rules for specific functions?
I know that it's possible to use exclude to skip all numpydoc validation for matching functions, and that it's possible to use inline comments skip checking of specific rules for specific functions on a case-by-case basis. Is there any intermediate configuration possible? I would like to skip checking EX01 on all private functions (those starting with _), but validate all other rules on those functions (and EX01 on all functions that don't start with _).
(I could manually add inline comments for each private function, but it feels like there must be a better way.)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing numpydoc's existing exclude configuration and inline-comment handling described in the issue. Determine whether a rule-specific pattern for private functions can be configured while preserving the other validation rules, and define tests or documentation that demonstrate the expected behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100