Fix invalid escape sequence in einsum docstring #298
Merged
Conversation
This file contains 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
Current einsum docstring has an invalid escape sequence, specifically in the `\sum` for some LaTeX code.
This can be checked by running the following:
```bash
$ PYTHONWARNINGS=error python -c "import einops"
Traceback (most recent call last):
File "<string>", line 1, in <module>
File "~/.venv/lib/python3.10/site-packages/einops/__init__.py", line 14, in <module>
from .einops import rearrange, reduce, repeat, einsum, parse_shape, asnumpy
File "~/.venv/lib/python3.10/site-packages/einops/einops.py", line 827
"""
^^^
```
This can be annoying, especially when running tests if one wants to run them in strict mode (warnings-as-errors)
Replacing with a raw docstring removes the issue.
|
Interesting catch @atwam , I wonder how ruff ignores this. And when I run PYTHONWARNINGS=error python -c "import einops"on python3.10 on mac, it reports nothing back too. |
|
Hum, I'm on python 3.10.11 on WSL/Ubuntu |
|
Interstingly, it complains on just using '\s', but does not complain on einops import, so I can't check if this is resolved. Hopefully yes |
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.
Current einsum docstring has an invalid escape sequence, specifically in the
\sumfor some LaTeX code. This can be checked by running the following:This can be annoying, especially when running tests if one wants to run them in strict mode (warnings-as-errors) Replacing with a raw docstring removes the issue.