pydocstyle checks
Open
Nobody has claimed this yet.
documentation
repo-logistics
- Dominant language
- Python
- Stars
- 12
- Forks
- 11
- Avg merge
- 7d 23h
- Merged PRs (30d)
- 3
Description
Add pydocstyle (or similar) checks in CI pipelines (and pre-commit hooks) so that new code is required to have decent documentation.
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
No files, tests, or CI entry points are named in the issue. Start by locating the repository's CI configuration and pre-commit configuration, then determine how a pydocstyle check would run in both; done means new code is checked for documentation in CI and through the pre-commit hooks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100