Escape underscores #208
Merged
Escape underscores #208
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
This allows for generating symbols with subscripts (possibly multiple layers), e.g. `x_2_i` becomes `x_{2_{i}}`. This option also creates the possibility of generating invalid latex if the identifier starts or ends with an underscore, or has a double underscore in it. In these cases we now raise a ValueError.
…ores` option in IdentifierConverter
|
This feature would be awesome |
odashi
reviewed
Feb 3, 2025
Previously generated latex was incorrect for multi-character subscripts. Tests updated to reflect new (correct) behaviour.
bjude
force-pushed
the
escape_underscores
branch
from
6604d2f to
625444f
Compare
…scaping underscores
|
@bjude I would merge this PR after all CIs passed. |
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.
Overview
Add the option to not escape underscores in IdentifierConverter
Details
This allows for generating symbols with subscripts (possibly multiple layers), e.g. x_2_i becomes x_{2_{i}}. This is done by splitting the identifier on underscores, converting each 'sub-identifier' as normal, then concatenating the converted identifiers back together, separated by underscores. There is some simple logic in the concatenation to wrap the subscripts in braces to accommodate multiple layers of subscripts.
This option also creates the possibility of generating invalid latex if the identifier starts or ends with an underscore, or has a double underscore in it. In these cases we now raise a ValueError. Tests have been added exercising the new functionality, including the error path.