GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — Add documentation page for typing-extensions by JelleZijlstra · Pull Request #166 · python/typing_extensions

Conversation

JelleZijlstra commented May 21, 2023

Copy link

Copy Markdown

Member

Currently, typing-extensions is documented only through the README and CHANGELOG. This is hard to navigate, so I feel it's time for a documentation page dedicated to typing-extensions.

We can host it at typing-extensions.readthedocs.io.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions


          Add documentation page for typing-extensions

20fa28f

AlexWaygood reviewed

May 21, 2023

View reviewed changes

AlexWaygood left a comment

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, and very much needed — thank you!

Some comments, mostly pretty minor:

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

AlexWaygood reviewed

May 21, 2023

View reviewed changes

AlexWaygood left a comment

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, and very much needed — thank you!

Some comments, mostly pretty minor:

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

JelleZijlstra commented

May 21, 2023

View reviewed changes

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

JelleZijlstra and others added 3 commits

May 21, 2023 05:50


          Apply suggestions from code review

d6eb813

Co-authored-by: Alex Waygood <[email protected]>


          Merge remote-tracking branch 'upstream/main' into doc

00fb8ad


          More in -> on

e0acf93

AlexWaygood reviewed

May 21, 2023

View reviewed changes

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.


          changed, not added

969853d

AlexWaygood reviewed

May 21, 2023

View reviewed changes

AlexWaygood left a comment

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few more small points:

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

doc/index.rst Outdated

Comment on lines +594 to +595

		Certain types have incorrect runtime behavior due to limitations of older
		versions of the typing module:

AlexWaygood May 21, 2023

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make it slightly clearer that this is a distinct point to the previous paragraph:

Suggested change

	Certain types have incorrect runtime behavior due to limitations of older
	versions of the typing module:
	As well as this, certain types have incorrect runtime behavior due to
	limitations of older versions of the typing module:

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

JelleZijlstra May 21, 2023

Copy link

Copy Markdown

Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually think we should get rid of this catch-all section and document these limitations only under specific objects. I'll move a version of this text to the ParamSpec docs instead, and get rid of the sentence about Sequence/Reversible which I think is only relevant to 3.5-era changes.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

AlexWaygood May 21, 2023

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that makes sense. Sounds like a plan.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

JelleZijlstra May 21, 2023

Copy link

Copy Markdown

Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't figure out what's supposedly wrong with Concatenate, so I'm going to add a note to ParamSpec only.

Python 3.8.16 (default, Dec 26 2022, 20:36:56) 
[Clang 14.0.0 (clang-1400.0.29.202)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> from typing_extensions import Concatenate, get_args, get_origin, ParamSpec
>>> P = ParamSpec("P")
>>> c = Concatenate[int, P]
>>> get_origin(c)
typing_extensions.Concatenate
>>> get_args(c)
(<class 'int'>, ~P)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

AlexWaygood May 21, 2023 •

edited

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't figure out what's supposedly wrong with Concatenate, so I'm going to add a note to ParamSpec only.

Makes sense, though #110 might be worth a mention in the Concatenate entry. I took a brief look at it a while back, and it looks... challenging to backport.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

AlexWaygood May 21, 2023

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#48 as well...

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

JelleZijlstra May 21, 2023

Copy link

Copy Markdown

Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, added those. I also noticed that the :gh: links to CPython weren't working, so I added a custom Sphinx extension to make them work (possibly overkill?).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

AlexWaygood May 21, 2023

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

possibly overkill?

Definitely a Choice, but I'll support you in it

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

JelleZijlstra commented

May 21, 2023

View reviewed changes

Comment thread

doc/index.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

JelleZijlstra and others added 6 commits

May 21, 2023 13:49


          Apply suggestions from code review

Co-authored-by: Alex Waygood <[email protected]>


          Update doc/index.rst

7e61686

Co-authored-by: Alex Waygood <[email protected]>


          changed not added

4c29bce


          Update doc/index.rst

722ac0b


          Remove limitations section

3d903ad

- The stuff about Reversible is no longer relevant
- Can't confirm issues with Concatenate
- Add note specifically to ParamSpec docs


          PEP links

90567ff

AlexWaygood approved these changes

May 21, 2023

View reviewed changes

AlexWaygood left a comment

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

JelleZijlstra added 3 commits

May 21, 2023 15:37


          Custom extension for GH links


          black

c5fa980


          lint

314c104

JelleZijlstra merged commit 024d465 into python:main

May 21, 2023

JelleZijlstra deleted the doc branch

May 21, 2023 22:41

JelleZijlstra commented May 21, 2023

Copy link

Copy Markdown

Member Author

Next step: get this deployed. Other followups:

Migrate changelog to RST and put it on this docs page
Trim down the README to remove redundancy with this page
Consider extending the introduction, maybe a section specifically on the versioning scheme and/or backward compatibility

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

JelleZijlstra restored the doc branch

September 10, 2024 23:39

brianschubert mentioned this pull request

Mar 23, 2025

Bump intersphinx base for Python docs to 3.13 #549

Merged

Reviewers

AlexWaygood

AlexWaygood approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.

Conversation

JelleZijlstra commented May 21, 2023

Uh oh!

AlexWaygood left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AlexWaygood left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AlexWaygood left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexWaygood May 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AlexWaygood left a comment

Choose a reason for hiding this comment

Uh oh!

JelleZijlstra commented May 21, 2023

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

AlexWaygood May 21, 2023 •

edited

Loading

Uh oh!

There was an error while loading. Please reload this page.