Using multiple return values in Google-style docstrings
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
How pdoc deals with multiple return values in Google-style docstrings. What are the best practices for this scenario?
I have tried version 3, but the rendered html returns section does not look like the args section.
Can I force pdoc to render the returns using the same format as the args? any help is appreciated.
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
Read the linked Sphinx issue and compare its multiple-return examples with the reported pdoc rendered HTML. Reproduce the Google-style docstring case and determine whether the result needs documentation or a rendering change; done means the supported behavior and best-practice format are clear.
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
- 25/100