10000 bpo-30181: parse docstring using pydoc by brianmay · Pull Request #1505 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

bpo-30181: parse docstring using pydoc #1505

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

Closed
wants to merge 13 commits into from
Closed

bpo-30181: parse docstring using pydoc #1505

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
e77fa7a
Add test cases for single-line test case docstring.
benf-wspdigital May 1, 2017
538ab19
Add test cases for stripping surrounding space for shortDescription.
benf-wspdigital May 1, 2017
cec5371
Add test cases for test case docstring with surrounding newlines.
benf-wspdigital May 1, 2017
d1315d4
Parse the test case docstring using `pydoc.splitdoc`.
benf-wspdigital May 1, 2017
5c71fd0
Change docstring into comment for internal function
brianmay May 21, 2017
0094fdc
Merge surrounding space test with existing tests
brianmay May 21, 2017
b4fe113
Prefix internal function with _
brianmay May 21, 2017
e3dbe3e
Fix broken docstrings
brianmay May 21, 2017
669b46d
Fix docstring for shortDescription
brianmay May 21, 2017
0caec7e
Rename internal function
brianmay May 24, 2017
1720114
Rename text parameter to doc
brianmay May 24, 2017
30cec86
Use guard clause for internal function
brianmay May 24, 2017
ea60b7b
Replace comment with docstring
brianmay May 24, 2017
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
Use guard clause for internal function
  • Loading branch information
@brianmay
brianmay committed May 24, 2017
commit 30cec86e437da3f6af5501f4fadb64bec03e3a84
10 changes: 4 additions & 6 deletions Lib/unittest/case.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,13 +342,11 @@ def __exit__(self, exc_type, exc_value, tb):
def _get_short_description(doc):
# Return the summary line from a docstring.
Copy link
Member

Choose a reason for hiding this comment

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

This should be part of a docstring, not code comment.

Copy link
Member

Choose a reason for hiding this comment

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

I suggested to replace too verbose docstring in initial commit with shorter comment. But since it was shortened I'm nice with a docstring too.

# If there is no summary line, return None.
if doc:
(synopsis, long_description) = pydoc.splitdoc(doc)
synopsis = synopsis.strip()
else:
# The text is either an empty string, or some other false value.
synopsis = None
if not doc:
return None

(synopsis, long_description) = pydoc.splitdoc(doc)
synopsis = synopsis.strip()
return synopsis


Expand Down
0