mapbox / mapbox/watchbot-progress-py
pydocstyle reports 18 missing docstrings
Open
Nobody has claimed this yet.
bug
- Dominant language
- Python
- Stars
- 1
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
$ python -m pydocstyle --count --select=D1 --add-ignore=D105 .
...
18
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
Run python -m pydocstyle --count --select=D1 --add-ignore=D105 . from the repository root to reproduce the count and inspect the reported missing-docstring locations. Add docstrings for the 18 reported items, then rerun the same command and confirm the count is resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100