Skip to content
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

gh-41872: Parse docstrings with ast instead of string manipulation #127520

Merged
merged 29 commits into from
Jan 8, 2025
Merged

gh-41872: Parse docstrings with ast instead of string manipulation #127520

Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
9e0835c
Instead of manual parsing of doc strongs, use ast.literal_eval to par…
srinivasreddy Dec 2, 2024
d9fe8dd
Add tests for doc strings
srinivasreddy Dec 2, 2024
ab176ab
Remove unnecessary comments
srinivasreddy Dec 2, 2024
c21f342
Fix typo
srinivasreddy Dec 2, 2024
d750ee5
Update Lib/pydoc.py
srinivasreddy Dec 3, 2024
38b13e5
Add breathing space
srinivasreddy Dec 3, 2024
4bb399d
Fix name collision / shadowing
srinivasreddy Dec 3, 2024
272ca67
Change the logic
srinivasreddy Dec 3, 2024
5ef8adb
Fix typo
srinivasreddy Dec 3, 2024
e306542
Update Lib/pydoc.py
srinivasreddy Dec 5, 2024
6ff1ac3
Address review comments
srinivasreddy Dec 5, 2024
8c073a5
Correct the logic
srinivasreddy Dec 5, 2024
91df3f0
Merge branch 'main' into gh-41872
srinivasreddy Dec 17, 2024
f122cc6
Add blurb
srinivasreddy Dec 17, 2024
08cf0a5
Merge branch 'main' into gh-41872
srinivasreddy Dec 18, 2024
5e6a78b
Remove the redundant binary file check
srinivasreddy Dec 18, 2024
f54711e
Update test cases
srinivasreddy Dec 18, 2024
fb5dc83
Update Lib/test/test_pydoc/test_pydoc.py
srinivasreddy Dec 18, 2024
bd0e7eb
Update Lib/test/test_pydoc/test_pydoc.py
srinivasreddy Dec 18, 2024
233fbd6
Update Lib/test/test_pydoc/test_pydoc.py
srinivasreddy Dec 18, 2024
ec7e431
Update Lib/test/test_pydoc/test_pydoc.py
srinivasreddy Dec 18, 2024
c004506
Update Lib/test/test_pydoc/test_pydoc.py
srinivasreddy Dec 18, 2024
204e5bb
Add commas
srinivasreddy Dec 19, 2024
dae74dd
Merge branch 'main' into gh-41872
srinivasreddy Jan 6, 2025
54519d9
Address review comments
srinivasreddy Jan 6, 2025
835fea2
Update Lib/test/test_pydoc/test_pydoc.py
srinivasreddy Jan 6, 2025
b7c42ea
Handle concatenated string, parentheses, newlines, and add more tests.
serhiy-storchaka Jan 7, 2025
6d6e983
Add more tests. Refactor tests.
serhiy-storchaka Jan 8, 2025
511b5d0
Update a NEWS entry.
serhiy-storchaka Jan 8, 2025
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
Remove unnecessary comments
  • Loading branch information
@srinivasreddy
srinivasreddy committed Dec 3, 2024
commit ab176ab082fc42d3273e2163b29579b3f266d30e
5 changes: 0 additions & 5 deletions Lib/test/test_pydoc/test_pydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -901,31 +901,26 @@ def test_synopsis(self):

def test_source_synopsis(self):
test_cases = [
# Single line docstring
('"""Single line docstring."""',
"Single line docstring."),

# Multi-line docstring - should only return first line
('"""First line of docstring.\nSecond line.\nThird line."""',
"First line of docstring."),

# Docstring with leading/trailing whitespace
('""" Whitespace around docstring. """',
"Whitespace around docstring."),

# No docstring
('x = 1\ny = 2',
None),

# Comments before docstring
('# Comment\n"""Docstring after comment."""',
"Docstring after comment."),

# Empty docstring
('""""""',
""),

# Unicode docstring
('"""Café and résumé."""',
"Café and résumé."),
]
Expand Down