Update reference/generics.html with PEP695 type parameter syntax
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 302
- Avg merge
- 23h
- Merged PRs (30d)
- 8
Description
The typing documentation for generics is somewhat inconsistent in the use of new syntax:
-
Generics — typing documentation (https://typing.python.org/en/latest/reference/generics.html) doesn’t include the new syntax class Foo[T] at all
-
Generics — typing documentation (https://typing.python.org/en/latest/spec/generics.html) does, and mentions PEP695
Are there any plans on updating reference/generics.html? It is a bit confusing for someone who is using Python 3.12 or newer to see out-of-date information.
Contributor guide
No contributing guide indexed for this repository
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 reference/generics.html and compare its generics guidance with spec/generics.html, especially the PEP 695 material and class Foo[T] syntax. Update the reference page so its treatment of generic syntax is consistent with the specification, then review the rendered documentation for matching examples and wording.
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
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 76/100