Fix invalid escape sequence in balloon.py docstring #324
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.
(I had Copilot try to resolve this)
This PR fixes a SyntaxWarning that was being generated when importing the balloon module due to invalid escape sequences in the docstring.
Issue
The docstring in
src/balloon.pycontained\-sequences which are not valid Python escape sequences, causing Python to emit warnings like:Solution
Fixed the escape sequences by properly escaping the backslashes:
The \-directional→The \\-directionalcrossing a \-directional→crossing a \\-directionalChanges Made
__init__method docstringTesting
py_compileThe fix is minimal and surgical - only two characters were changed to properly escape the backslashes in the docstring, eliminating the SyntaxWarning while preserving the intended documentation meaning and all functionality.
Fixes #321
Fixes #314
Fixes #317