Search: fix parsing of parameters inside sphinx domains #9750
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We were removing all dl lists that were inside a domain in order to remove nested domains, but in doing so we were removing parameters (they are inside a dl list!). Instead, let's reuse the method to detect sphinx domains.
stsewd
commented
Nov 21, 2022
| @@ -40,6 +40,6 @@ | |||
| ], | |||
| "domain_data": { | |||
| "test_py_module.test.Foo": "Docstring for class Foo. This text tests for the formatting of docstrings generated from output sphinx.ext.autodoc.", | |||
| "test_py_module.test.Foo.__init__": "Start the Foo." | |||
| "test_py_module.test.Foo.__init__": "Start the Foo. Parameters: qux (string) – The first argument to initialize class. spam (bool) – Spam me yes or no…" | |||
There was a problem hiding this comment.
funny, we already had that test case, but we were expecting the wrong result :D
agjohnson
approved these changes
Nov 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We were removing all dl lists that were inside a domain in order to remove nested domains, but in doing so we were removing parameters (they are inside a dl list!).
Instead, let's reuse the method to detect sphinx domains.