Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FR: Add Link to Typing RTD in typing Module #96917

Closed
adam-grant-hendry opened this issue Sep 18, 2022 · 1 comment
Closed

FR: Add Link to Typing RTD in typing Module #96917

adam-grant-hendry opened this issue Sep 18, 2022 · 1 comment
Labels
topic-typing type-feature A feature request or enhancement

Comments

@adam-grant-hendry
Copy link

adam-grant-hendry commented Sep 18, 2022

Feature or enhancement

Discussions on adding a link to the typing readthedocs (RTD) on the typing module documentation page have been had:

The request is to add a link to the top of the typing module docs linking readers to the page. This would serve the following needs:

  1. The RTD is not particularly discoverable via search engines (the most notable link is in the README of the typeshed repo)
  2. A desire has been expressed for incorporating PEPs into a series of HOWTOs and some consensus has been achieved that the RTD would be the best place for this

Pitch

Please add a link to the typing readthedocs on the python typing module docs page.

The OP is open to any implementation resulting in an easily findable and noticeable hyperlink for users.

Previous discussion

Repeated from above:

@adam-grant-hendry adam-grant-hendry added the type-feature A feature request or enhancement label Sep 18, 2022
hauntsaninja added a commit to hauntsaninja/cpython that referenced this issue Sep 18, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Sep 19, 2022
…GH-96921)

See the discussion at python#91533
(cherry picked from commit 5b3a256)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
gvanrossum pushed a commit that referenced this issue Sep 19, 2022
hauntsaninja added a commit to hauntsaninja/cpython that referenced this issue Sep 19, 2022
hauntsaninja added a commit to hauntsaninja/cpython that referenced this issue Sep 19, 2022
…ythonGH-96921)

See the discussion at python#91533.
(cherry picked from commit 5b3a256)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
hauntsaninja added a commit to hauntsaninja/cpython that referenced this issue Sep 19, 2022
…ythonGH-96921)

See the discussion at python#91533.
(cherry picked from commit 5b3a256)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
miss-islington added a commit that referenced this issue Sep 19, 2022
See the discussion at #91533
(cherry picked from commit 5b3a256)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Fidget-Spinner pushed a commit that referenced this issue Sep 20, 2022
) (GH-96937)

See the discussion at #91533.
(cherry picked from commit 5b3a256)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
@AlexWaygood
Copy link
Member

The link has been added, and the change has been backported to 3.11 and 3.10.

pablogsal pushed a commit that referenced this issue Oct 22, 2022
See the discussion at #91533
(cherry picked from commit 5b3a256)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic-typing type-feature A feature request or enhancement
Projects
None yet
Development

No branches or pull requests

2 participants