python / python/typing

Remove PEP references in Typing Python Libraries guide

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

Nobody has claimed this yet.

topic: documentation
Dominant language
Python
Stars
1.8k
Forks
302
Avg merge
23h
Merged PRs (30d)
8

Description

The Typing Python Libraries (and possibly other guides) contains quite a few references to specific PEPs. These links should probably point to other guides, the Python documention, or the typing spec, instead.

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.

Research direction

Start with the Typing Python Libraries guide at https://typing.python.org/en/latest/guides/libraries.html and review its links to specific PEPs, then check whether other guides contain similar references. Replace those links with relevant guides, Python documentation, or the typing spec, and consider the work done when the inappropriate PEP references have been removed.

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
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.