Docstring format convention
Open
Nobody has claimed this yet.
command line tools
documentation
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of feature
I think it would be great to decide on a docstring format for this project to have a chance to use them consistently throughout the codebase for documentation and the generation of user friendly API docs.
The formats I like most are the one from Google and numpy with a slight preference for the latter.
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 by comparing the Google and NumPy docstring references linked in the issue, then inspect the Python codebase for existing docstring styles. Done means the project has chosen and documented one convention, with a clear basis for using it consistently and generating user-friendly API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100