Skip to content

Fix Python docstring type handling bug #10738

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
merged 13 commits into from
Aug 2, 2022
Merged

Fix Python docstring type handling bug #10738

Changes from 3 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
709fb3e
Fix type handling bug
ProGamerGov Jul 31, 2022
47a70f8
Flake8
AA-Turner Jul 31, 2022
6c5f6c3
Revert Flake8 change, failures unrelated
AA-Turner Jul 31, 2022
38c6da4
Fix regex whitespace
ProGamerGov Jul 31, 2022
771ccb1
Add changes to AUTHORS, CHANGES, & tests
ProGamerGov Aug 1, 2022
d65d9cd
Improve napoleon test case
ProGamerGov Aug 1, 2022
c2e52e6
Improving testing coverage for napoleon 'of'
ProGamerGov Aug 1, 2022
d37e841
Improve testing coverage
ProGamerGov Aug 1, 2022
94f6603
Add delineator tests to Python domain testing
ProGamerGov Aug 2, 2022
5c35a56
Update CHANGES
ProGamerGov Aug 2, 2022
db374c8
Add bugfix line
ProGamerGov Aug 2, 2022
7e7f25d
Fix bug fix line
ProGamerGov Aug 2, 2022
2957f43
Fix flake8 error
ProGamerGov Aug 2, 2022
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
2 changes: 1 addition & 1 deletion sphinx/domains/python.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ def make_xrefs(self, rolename: str, domain: str, target: str,
innernode: Type[TextlikeNode] = nodes.emphasis,
contnode: Node = None, env: BuildEnvironment = None,
inliner: Inliner = None, location: Node = None) -> List[Node]:
delims = r'(\s*[\[\]\(\),](?:\s*or\s)?\s*|\s+or\s+|\s*\|\s*|\.\.\.)'
delims = r'(\s*[\[\]\(\),](?:\s*or|of\s)?\s*|\s+or|of\s+|\s*\|\s*|\.\.\.)'
delims_re = re.compile(delims)
sub_targets = re.split(delims, target)

Expand Down