Italicize type-only values in `Returns` section
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
type-only values as in
Returns
-------
int
should be in italics for consistency with the parameter_name : int style, where int would be in italics.
Possible reason not to do this: "type-only" is just a convention and it could also be "name-only" and numpydoc wants to stay agnostic on this. If this is the case, feel free to close.
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
The issue does not name a file or test. Locate the code that parses or renders Returns sections and compare it with the existing parameter_name : int formatting; then find the relevant test coverage. Done means type-only values such as int render in italics consistently, with tests covering the updated output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100