Spec: PEP leftovers in the spec for literals

Open Beginner friendly
#2,355 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
75/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

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.

Description

topic: typing spec

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.
Dominant language
Python
Stars
1.8k
Forks
302
Avg merge
23h
Merged PRs (30d)
8

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from python/typing

All issues in python/typing

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.