Spec: PEP leftovers in the spec for literals
Open
Beginner friendly
Nobody has claimed this yet.
topic: typing spec
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 302
- Avg merge
- 23h
- Merged PRs (30d)
- 8
Description
There are some sections in the spec for literals that made sense as a rationale or look into the future in the PEP, but should be removed in the spec for conciseness, clarity, and consistency:
- An (incomplete) list of illegal parameters for
Literal. Since this immediately succeeds a positive, exclusive list of what parameters are allowed, this is just fluff and I believe the whole section should just be removed. - The next section is titled "Parameters at runtime" and details implementation details for
Literal. These seem unnecessary for the typing spec and are in danger of getting desynched with the actual implementation.
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
Open the specification for literals and locate the sections on illegal parameters and parameters at runtime mentioned in the issue. Remove the rationale and implementation-detail sections while keeping the normative description concise, then review the rendered specification to confirm the surrounding content remains clear.
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
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 75/100