Fix spelling:word role rendering verbatim #189
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
|
Updated commit fixes linting issues as well as adds an entry to This project should have a |
dhellmann
reviewed
Oct 7, 2022
| docname = env.docname | ||
| good_words = text.split() | ||
| directive.add_good_words_to_document(env, docname, good_words) | ||
| node = nodes.Text(text) |
There was a problem hiding this comment.
This does look much simpler. Is the real fix that this Text node is initialized differently than when GenericRole creates it?
There was a problem hiding this comment.
Yes, I think so. I struggled to understand the route that the original code took to create the final Text node, but it does seem like that is the case.
A line like:
This :spelling:word`foobared` role needs to be fixed.
would be rendered in the output exactly like that, instead of what it
should be:
This foobared role needs to be fixed.
Turns out the cause is quite simple: the nodes.Text object from docutils
does not hold both the raw text and the "real" text, so it is being
passed the raw text, which includes the role name as we see it.
Add a test case to cover this as well.
Fixes #188
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.
A line like:
would be rendered in the output exactly like that, instead of what it should be:
Turns out the cause is quite simple: the nodes.Text object from docutils does not hold both the raw text and the "real" text, so it is being passed the raw text, which includes the role name as we see it.
Add a test case to cover this as well.
NOTE: The other (shorter) way to fix this is simply to change this line:
spelling/sphinxcontrib/spelling/role.py
Line 16 in f4a419e
to
But I think that is more hacky. If you disagree, I can edit this commit.
Fixes #188