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
Next Next commit
Add a newline after the docstring of unclassified object.
  • Loading branch information
@serhiy-storchaka
serhiy-storchaka committed Apr 17, 2020
commit fe96fea6d5e238c745de0cc92f6721d83923bc50
2 changes: 1 addition & 1 deletion Lib/pydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1445,7 +1445,7 @@ def docother(self, object, name=None, mod=None, parent=None, maxlen=None, doc=No
if not doc:
doc = getdoc(object)
if doc:
line += '\n' + self.indent(str(doc))
line += '\n' + self.indent(str(doc)) + '\n'
return line

class _PlainTextDoc(TextDoc):
Expand Down
3 changes: 2 additions & 1 deletion Lib/test/test_pydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1255,7 +1255,8 @@ class X:
X.attr.__doc__ = 'Custom descriptor'
self.assertEqual(self._get_summary_lines(X.attr), """\
<test.test_pydoc.TestDescriptions.test_custom_non_data_descriptor.<locals>.Descr object>
Custom descriptor""")
Custom descriptor
""")

X.attr.__name__ = 'foo'
self.assertEqual(self._get_summary_lines(X.attr), """\
Expand Down