fix: Show curly braces in pydocs correctly #1880 #2027
Merged
Conversation
This file contains 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
mturoci
approved these changes
Jun 19, 2023
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.
Pdoc builds the docs correctly when curly braces
{}are used.The problem is with docusaurus using the MDX compiler for
.mdfiles generated by pdoc while building the website.In MDX, curly braces are reserved for expressions so in our case the MDX compiler is looking for a
fruitvariable which is, obviously, not defined -@on('#foo/{fruit}'). We can fix this by writing an expression inside the curly braces which returns what we want, in our case{"{fruit}"}.Closes #1880