8000 Missing Deprecation Notice for typing.Callable Alias in the Deprecated Aliases section · Issue #106461 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Missing Deprecation Notice for typing.Callable Alias in the Deprecated Aliases section #106461

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.

Sign up for GitHub

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

Jump to bottom
Closed
ColemanDunn opened this issue Jul 5, 2023 · 2 comments
Closed

Missing Deprecation Notice for typing.Callable Alias in the Deprecated Aliases section #106461

ColemanDunn opened this issue Jul 5, 2023 · 2 comments
Labels
docs Documentation in the Doc dir topic-typing

Comments

@ColemanDunn
Copy link
ColemanDunn commented Jul 5, 2023 •
edited by bedevere-bot
Loading

Documentation

typing.Callable is not listed as a deprecated alias under https://docs.python.org/3/library/typing.html#deprecated-aliases.

However, it IS listed here: https://docs.python.org/3/library/typing.html#typing.Callable and states "Deprecated alias to collections.abc.Callable". But not having it anywhere in the Depricated Aliases section of the docs is confusing as the only depreciation notice lies outside of this section.

It seems like it could fit under this section: https://docs.python.org/3/library/typing.html#aliases-to-container-abcs-in-collections-abc as the language used in this section ("Deprecated alias to collections.abc.[...]") closely matches the language used callable depreciation notice, but I am not entirely sure it if fits the "container" description.

I suggest adding the deprecation notice to the Depricated Aliases section.

That is all! Thanks!

Linked PRs
@ColemanDunn ColemanDunn added the docs Documentation in the Doc dir label Jul 5, 2023
AlexWaygood added a commit to AlexWaygood/cpython that referenced this issue Jul 5, 2023
@AlexWaygood
pythongh-106461: Consolidate docs on Callable
854b2c5
@bedevere-bot bedevere-bot mentioned this issue Jul 5, 2023
Merged
@AlexWaygood
Copy link
Member

Luckily for you, I had already been working on this, just hadn't got round to making a PR yet :)

Please see #106462.

AlexWaygood added a commit that referenced this issue Jul 9, 2023
@AlexWaygood
gh-106461: typing: Consolidate docs on Callable (#106462)
ca8b55c
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 9, 2023
@AlexWaygood @miss-islington
pythongh-106461: typing: Consolidate docs on Callable (pythonGH-106462
66483a0 
)

(cherry picked from commit ca8b55c)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
This was referenced Jul 9, 2023
Merged
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 9, 2023
@AlexWaygood @miss-islington
pythongh-106461: typing: Consolidate docs on Callable (pythonGH-106462
55c21a4 
)

(cherry picked from commit ca8b55c)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood added a commit that referenced this issue Jul 9, 2023
@miss-islington @AlexWaygood
[3.12] gh-106461: typing: Consolidate docs on Callable (GH-106462) (#…
128a962 
…106574)

gh-106461: typing: Consolidate docs on `Callable` (GH-106462)
(cherry picked from commit ca8b55c)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood added a commit that referenced this issue Jul 9, 2023
@miss-islington @AlexWaygood
[3.11] gh-106461: typing: Consolidate docs on Callable (GH-106462) (#…
dd04697 
…106575)

gh-106461: typing: Consolidate docs on `Callable` (GH-106462)
(cherry picked from commit ca8b55c)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@AlexWaygood
Copy link
Member

Fixed and backported. The updates should appear in the online docs in the next day or so.

Thanks for the report @ColemanDunn!

1proprogrammerchant added a commit to 1proprogrammerchant/cpython that referenced this issue Jul 9, 2023
@1proprogrammerchant
Merge pull request #4 from python/main
3c41c9a 
pythongh-106461: typing: Consolidate docs on `Callable` (python#106462)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir topic-typing
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ColemanDunn @AlexWaygood
0