Improve docstring structuring for code autocompletion.
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 78
- Avg merge
- 8h 59m
- Merged PRs (30d)
- 24
Description
Originally opened by
@tomchristieon 2024-10-22 09:28:00 in encode/httpx
- The
__init__.pymodule should include a docstring. - Should class docstrings be on the class itself or on the class
__init__method (or both?). - Review if we've currently got a docstring on all public API, and review consistency & styling throughout.
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 package init.py and review the public API for missing or inconsistent docstrings. Determine a consistent placement and style for class and init docstrings, then verify that public symbols are documented in a way that supports code autocompletion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100