Use r-strings for docstrings containing LaTeX markup#1074
Open
mhucka wants to merge 1 commit into
Open
Conversation
mhucka
added
area/docs
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates several docstrings in fidelity_op.py, inner_product_op.py, and spin_system.py to use raw string literals (r"""). This change ensures that LaTeX mathematical expressions containing backslashes are interpreted correctly. I have no feedback to provide as there were no review comments.
mhucka
changed the title
MichaelBroughton
approved these changes
May 22, 2026
Collaborator
MichaelBroughton
left a comment
MichaelBroughton
left a comment
There was a problem hiding this comment.
Might want to double check how these render on the site.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 few docstrings in Python files contained LaTeX mathematical notation. They should be made into raw strings (using the
rprefix) so that Python doesn't misinterpret the backslash characters.There are no code or content changes in this PR.