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
7 changes: 5 additions & 2 deletions Lib/pydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1672,8 +1672,11 @@ def render_doc(thing, title='Python Library Documentation: %s', forceload=0,
inspect.getdoc(object)):
# If the passed object is a piece of data or an instance,
# document its available methods instead of its value.
object = type(object)
desc += ' object'
if hasattr(object, '__origin__'):
object = object.__origin__
else:
object = type(object)
desc += ' object'
return title % desc + '\n\n' + renderer.document(object, name)

def doc(thing, title='Python Library Documentation: %s', forceload=0,
Expand Down
10 changes: 10 additions & 0 deletions Lib/typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,14 @@ def __init__(self, name, doc):
self._name = name
self._doc = doc

@property
def __doc__(self):
return self._doc

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

@ilevkivskyi ilevkivskyi Apr 16, 2020

Choose a reason for hiding this comment

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

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


def __eq__(self, other):
if not isinstance(other, _SpecialForm):
return NotImplemented
Expand Down Expand Up @@ -672,6 +680,8 @@ def __init__(self, origin, params, *, inst=True, special=False, name=None):
self.__slots__ = None # This is not documented.
if not name:
self.__module__ = origin.__module__
if special:
self.__doc__ = f'A generic version of {origin.__module__}.{origin.__qualname__}'

@_tp_cache
def __getitem__(self, params):
Expand Down