Remove invalid escape sequence from docstring#441
Merged
kanekosh merged 3 commits intomdolab:mainfrom May 9, 2025
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #441 +/- ##
===========================================
- Coverage 85.97% 74.32% -11.65%
===========================================
Files 22 22
Lines 3315 3315
===========================================
- Hits 2850 2464 -386
- Misses 465 851 +386 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
kanekosh
approved these changes
May 9, 2025
Collaborator
kanekosh
left a comment
There was a problem hiding this comment.
Thank you for catching this!
Collaborator
|
Not sure if this was the intention What I would do instead is either double backslash e.g. |
Collaborator
|
Sorry I overlooked, I'll fix it |
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
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.

Purpose
This PR removes an invalid escape sequence from one docstring, and so fixes the warning:
Here is a stackoverflow post explaining the issue: https://stackoverflow.com/questions/52335970/how-to-fix-syntaxwarning-invalid-escape-sequence-in-python, and here are the valid escape sequences in Python: https://docs.python.org/3/reference/lexical_analysis.html#escape-sequences. You'll see that
\*is not listed.Expected time until merged
Not urgent.
Type of change
Testing
No testing needed, but I did run the tests in
testsand they seemed OK (but I don't have all the optimizers pyoptsparse supports so it's tough to tell).Checklist
flake8andblackto make sure the Python code adheres to PEP-8 and is consistently formattedfprettifyor C/C++ code withclang-formatas applicable