Force generating docstring for `__init__` functions
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 210
- Forks
- 36
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 2
Description
We should remove __init__.py:D104 from the per-file-ignores in .flake8 file to make sure they get documented.
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 with the per-file-ignores entry in .flake8 and inspect the repository's init.py files for the D104 violations that appear when the ignore is removed. Add the required documentation to those files, then run the project's flake8 checks to confirm no D104 violations remain.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100