Slash notation should be defined in a notation key at the beginning of the Built-In Functions section
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
Documentation
The Standard Library defines a number of built-in functions, and a shorthand notation is used when a function is defined, such as the definition of repr:
repr(object, /)
But there is no information about what that "/' means in the function signature. It is not standard computer science notation, so I started looking for its meaning. Normally, a notation key should be at the beginning of the document or section, but I do not find a notation key either at the beginning of the section or at the beginning of the documentation.
Could a notation key be added please, to define the meaning of this and any other non-standard notation that is used in the Python documentation?
Linked PRs
- gh-142641
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 at the Built-in Functions section of the Python Standard Library documentation and review the function-signature notation around repr(object, /). Add a notation key explaining the slash and any other non-standard notation identified there; the documentation is done when readers can understand these signatures without searching elsewhere.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100