Fix invalid escape sequences in qplayer docstring#461
Merged
Conversation
- also enable ruff W605 to catch this
fabinsch
force-pushed
the
fix-qplayer-doc-str
branch
2 times, most recently
from
4ea6fe4 to
9313b87
Compare
jorisv
approved these changes
May 11, 2026
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.
Closes #458.
The QPFunction docstring in
proxsuite/torch/qplayer.pycontains LaTeX and Doxygen markup with backslashes.Without the r prefix, Python treats these as string escapes, which raises a SyntaxWarning on 3.12+ (silent DeprecationWarning before)