openclimatefix / openclimatefix/.github
Ignore pydocstyle errors D100 and D103 on python unittest files
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- No language data
- Stars
- 1
- Forks
- 11
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Description
Detailed Description
Ignore these two pydocstyle errors on python unittest files:
- D100: Missing docstring in public module
- D103: Missing docstring in public function
Context
Unittest functions rarely have module or function docstrings!
Implementation
Is it possible to ignore all python filenames with test in the filename?
Contributor guide
No contributing guide indexed for this repository
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
Locate the repository's pydocstyle configuration and inspect how Python test filenames are identified. Verify that D100 and D103 are ignored for the intended unittest files without suppressing them elsewhere; no specific configuration file or test command is named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100