Use raw strings for docstrings containing LaTeX #429
Merged
+7
−7
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
`flake8` points out characters that will be misinterpreted in some function docstrings in `recirq/kpz/experiment.py`. The problem is the LaTeX commands in the docstrings. The misintepretation may cause the HTML generated documentation to be incorrect. The solution is to make the docstrings be raw strings. ``` recirq/kpz/experiment.py:170:61: W605 invalid escape sequence '\m' recirq/kpz/experiment.py:170:67: W605 invalid escape sequence '\i' recirq/kpz/experiment.py:180:61: W605 invalid escape sequence '\m' recirq/kpz/experiment.py:180:67: W605 invalid escape sequence '\i' recirq/kpz/experiment.py:192:61: W605 invalid escape sequence '\m' recirq/kpz/experiment.py:192:67: W605 invalid escape sequence '\i' recirq/kpz/experiment.py:202:61: W605 invalid escape sequence '\m' recirq/kpz/experiment.py:202:67: W605 invalid escape sequence '\i' recirq/kpz/experiment.py:237:59: W605 invalid escape sequence '\m' recirq/kpz/experiment.py:385:59: W605 invalid escape sequence '\m' recirq/kpz/experiment.py:395:52: W605 invalid escape sequence '\m' recirq/kpz/experiment.py:396:15: W605 invalid escape sequence '\m' recirq/kpz/experiment.py:396:19: W605 invalid escape sequence '\i' ```
fdmalone
approved these changes
Sep 19, 2025
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.
flake8points out characters that will be misinterpreted in some function docstrings inrecirq/kpz/experiment.py. The problem is the LaTeX commands in the docstrings. The misintepretation may cause the HTML generated documentation to be incorrect. The solution is to make the docstrings be raw strings.