Clarification on `:` in See Also.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
If the combination of the function name and the description creates a line that is too long, the entry may be written as two lines, with the function name and colon on the first line, and the description on the next line, indented four spaces:
How strict should we be with the colon ? It seem like numpy almost never put it in multiline,
and this is a bit incoherent with parameter section, where the colon is necessary if and only if there is a type parameter.
Should the advice to put a colon be removed ?
Or is it better to alway pt a colon to make the parsing easier ?
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
Review the quoted See Also multiline guidance and compare it with the parameter-section rule described in the issue. Done means resolving whether the colon should be required and updating the relevant documentation guidance accordingly; the payload does not identify a file or test.
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
- 25/100