Skip to content

bpo-40257: Improve help for the typing module #19546

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

Merged
serhiy-storchaka merged 4 commits into from
Apr 18, 2020
Merged

bpo-40257: Improve help for the typing module #19546

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e6f6015
bpo-40257: Improve help for the typing module
serhiy-storchaka Apr 15, 2020
b85e5c2
Remove the __doc__ setter in _SpecialForm.
serhiy-storchaka Apr 17, 2020
fe96fea
Add a newline after the docstring of unclassified object.
serhiy-storchaka Apr 17, 2020
d5b3e6d
Update docs.
serhiy-storchaka Apr 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update docs.
  • Loading branch information
@serhiy-storchaka
serhiy-storchaka committed Apr 18, 2020
commit d5b3e6d06fd1753e10088912a7bc23bafe396040
6 changes: 6 additions & 0 deletions Doc/whatsnew/3.9.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,12 @@ Other Language Changes
grammar was much more restrictive. See :pep:`614` for details.
(Contributed by Brandt Bucher in :issue:`39702`.)

* Improved help for the :mod:`typing` module. Docstrings are now shown for
all special forms and special generic aliases (like ``Union`` and ``List``).
Using :func:`help` with generic alias like ``List[int]`` will show the help
for the correspondent concrete type (``list`` in this case).
(Contributed by Serhiy Storchaka in :issue:`40257`.)


New Modules
===========
Expand Down
4 changes: 4 additions & 0 deletions Misc/NEWS.d/next/Library/2020-04-18-10-52-15.bpo-40257.lv4WTq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Improved help for the :mod:`typing` module. Docstrings are now shown for all
special forms and special generic aliases (like ``Union`` and ``List``).
Using ``help()`` with generic alias like ``List[int]`` will show the help
for the correspondent concrete type (``list`` in this case).