Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

comparison.py:11: SyntaxWarning: invalid escape sequence '\D' #32

Open
averyfreeman opened this issue Jun 12, 2024 · 0 comments
Open

comparison.py:11: SyntaxWarning: invalid escape sequence '\D' #32

averyfreeman opened this issue Jun 12, 2024 · 0 comments

Comments

@averyfreeman
Copy link

Hi, looks like your :math:\\Din the docstring ofcomparison.pyis throwing my interpreter, I'm onPython 3.12.3` Arch Linux OS

❯ python plot_color_gradients.py
/usr/lib/python3.12/site-packages/colorspacious/comparison.py:11: SyntaxWarning: invalid escape sequence '\D'
  """Computes the :math:`\Delta E` distance between pairs of colors.

I put a second backslash behind every single backslash in the docstring, and I can use the library now. I am not familiar with the :math: escapes, so I am not sure what that does to your document formatting.

I found discussion concerning the issue I faced on stackoverflow.com

If double-escapes break formatting for sphinx, maybe put the docstring in a separate file (?)
emollier added a commit to emollier/colorspacious that referenced this issue Nov 29, 2024
@emollier
c/comparison.py: make docstring a raw string.
0aa5371 
The docstring describing the deltaE function contains several
mathematical symbols with LaTeX-style syntax, causing python3.12 and
newer to throw SyntaxWarning, like reported in issue njsmith#32, or like
[Debian bug #1085424].  Converting it to raw string prevents attempts
to interpret the backslash character as if it were an invalid escape
sequence in a C string.

[Debian bug #1085424]: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1085424

Signed-off-by: Étienne Mollier <[email protected]>
@emollier emollier mentioned this issue Nov 29, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@averyfreeman