[question] docstring Returns section not applicable for classes?
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
The documentation https://numpydoc.readthedocs.io/en/latest/format.html#id10
Says that the Returns section is not applicable in class docstrings.
What to do if the class implements __call__?
E.g. vectorize uses the section https://docs.scipy.org/doc/numpy/reference/generated/numpy.vectorize.html
Thanks
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 linked numpydoc format documentation and compare its class-docstring guidance with the linked numpy.vectorize example. Determine whether callable classes should document their return value, then clarify the rule in the documentation and ensure the example follows it.
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
- Needs clarification
- Newbie friendliness
- 35/100