Fix backslash escaping issues in docstrings #543
Merged
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
Escape backslashes that should be passed through to the documentation system rather than interpreted as backslash escape sequences in the Python string. This fixes a number of SyntaxWarning instances about invalid escape sequences in Python 3.12. An alternative would be to make these docstrings raw strings (r"""foo""").
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #543 +/- ##
========================================
Coverage 84.71% 84.71%
========================================
Files 297 297
Lines 27632 27632
Branches 3660 3361 -299
========================================
Hits 23409 23409
Misses 3269 3269
Partials 954 954
☔ View full report in Codecov by Sentry. |
|
Alternatively add r for raw string before ". |
|
My preference would also be for raw strings. |
|
I’m happy to convert these docstrings to raw strings when I have a little time in front of a computer. |
Exception: don’t touch doc/devel/tools/tricked_out_emacs.rst for now.
effigies
approved these changes
Nov 9, 2023
Co-authored-by: Chris Markiewicz <effigies@gmail.com>
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.
Escape backslashes that should be passed through to the documentation system rather than interpreted as backslash escape sequences in the Python string.
This fixes a number of
SyntaxWarninginstances about invalid escape sequences in Python 3.12.An alternative would be to make these docstrings raw strings (
r"""foo""").