← 返回首页
bpo-40257: Improve help for the typing module by serhiy-storchaka · Pull Request #19546 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

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

Merged
serhiy-storchaka merged 4 commits into
python:masterfrom
serhiy-storchaka:typing-pydoc
Apr 18, 2020
Merged

bpo-40257: Improve help for the typing module#19546
serhiy-storchaka merged 4 commits into
python:masterfrom
serhiy-storchaka:typing-pydoc

Conversation

serhiy-storchaka commented Apr 15, 2020 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Member
  • Show docstring for special forms.
  • Show docstring for special generic aliases.
  • Show documentation for __origin__ for generic aliases.

https://bugs.python.org/issue40257

bpo-40257: Improve help for the typing module …
e6f6015
* Show docstring for special forms. * Show docstring for special generic aliases. * Show documentation for __origin__ for generic aliases.
gvanrossum approved these changes Apr 16, 2020
View reviewed changes

gvanrossum left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Looks good to me. But let's see what @ilevkivskyi thinks.

gvanrossum commented Apr 16, 2020

Copy link
Copy Markdown
Member

Playing with this, I noticed that pydoc.doc(Any) prints output that doesn't end in a \n. Is that expected? (I really don't know anything about pydoc.)

ilevkivskyi approved these changes Apr 16, 2020
View reviewed changes

ilevkivskyi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Thanks! Looks good, I have just one optional question.

Comment thread Lib/typing.py Outdated

@__doc__.setter
def __doc__(self, value):
self._doc = value

ilevkivskyi Apr 16, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Do we need this to be settable? If possible I would keep it read-only, but it is not very important.

gvanrossum approved these changes Apr 18, 2020
View reviewed changes

gvanrossum left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Thanks!

serhiy-storchaka merged commit 7e64414 into python:master Apr 18, 2020
serhiy-storchaka deleted the typing-pydoc branch April 18, 2020 14:13
CuriousLearner added a commit to CuriousLearner/cpython that referenced this pull request May 29, 2020
Merge branch 'master' into bpo-26543 …
e4d193d
* master: (1985 commits) bpo-40179: Fix translation of #elif in Argument Clinic (pythonGH-19364) bpo-35967: Skip test with `uname -p` on Android (pythonGH-19577) bpo-40257: Improve help for the typing module (pythonGH-19546) Fix two typos in multiprocessing (pythonGH-19571) bpo-40286: Use random.randbytes() in tests (pythonGH-19575) bpo-40286: Makes simpler the relation between randbytes() and getrandbits() (pythonGH-19574) bpo-39894: Route calls from pathlib.Path.samefile() to os.stat() via the path accessor (pythonGH-18836) bpo-39897: Remove needless `Path(self.parent)` call, which makes `is_mount()` misbehave in `Path` subclasses. (pythonGH-18839) bpo-40282: Allow random.getrandbits(0) (pythonGH-19539) bpo-40302: UTF-32 encoder SWAB4() macro use a|b rather than a+b (pythonGH-19572) bpo-40302: Replace PY_INT64_T with int64_t (pythonGH-19573) bpo-40286: Add randbytes() method to random.Random (pythonGH-19527) bpo-39901: Move `pathlib.Path.owner()` and `group()` implementations into the path accessor. (pythonGH-18844) bpo-40300: Allow empty logging.Formatter.default_msec_format. (pythonGH-19551) bpo-40302: Add pycore_byteswap.h header file (pythonGH-19552) bpo-40287: Fix SpooledTemporaryFile.seek() return value (pythonGH-19540) Minor modernization and readability improvement to the tokenizer example (pythonGH-19558) bpo-40294: Fix _asyncio when module is loaded/unloaded multiple times (pythonGH-19542) Fix parameter names in assertIn() docs (pythonGH-18829) bpo-39793: use the same domain on make_msgid tests (python#18698) ...
serhiy-storchaka mentioned this pull request Apr 10, 2022
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

gvanrossum gvanrossum approved these changes
ilevkivskyi ilevkivskyi approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Footer

© 2026 GitHub, Inc.