Skip to content

bpo-40257: Tweak docstrings for special generic aliases. #20022

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 1 commit into from
May 10, 2020
Merged

bpo-40257: Tweak docstrings for special generic aliases. #20022

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
bpo-40257: Tweak docstrings for special generic aliases. 
* Add the terminating period.
* Omit module name for builtin types.
  • Loading branch information
@serhiy-storchaka
serhiy-storchaka committed May 10, 2020
commit 6ecd123236629c03b09b471f915007579ad5a549
5 changes: 4 additions & 1 deletion Lib/typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -753,7 +753,10 @@ def __init__(self, origin, nparams, *, inst=True, name=None):
name = origin.__name__
super().__init__(origin, inst=inst, name=name)
self._nparams = nparams
self.__doc__ = f'A generic version of {origin.__module__}.{origin.__qualname__}'
if origin.__module__ == 'builtins':
self.__doc__ = f'A generic version of {origin.__qualname__}.'
else:
self.__doc__ = f'A generic version of {origin.__module__}.{origin.__qualname__}.'

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