xrft icon indicating copy to clipboard operation
xrft copied to clipboard

SyntaxWarning: invalid escape sequence '\m' in doc string

Open juntyr opened this issue 9 months ago • 1 comments

Loading the xrft package v1.0.1 produces the following warnings on Python 3.12:

/lib/python3.12/site-packages/xrft/xrft.py:284: SyntaxWarning: invalid escape sequence '\m'
  """
/lib/python3.12/site-packages/xrft/xrft.py:491: SyntaxWarning: invalid escape sequence '\m'
  """
/lib/python3.12/site-packages/xrft/xrft.py:691: SyntaxWarning: invalid escape sequence '\o'
  """
/lib/python3.12/site-packages/xrft/xrft.py:796: SyntaxWarning: invalid escape sequence '\o'
  """
/lib/python3.12/site-packages/xrft/xrft.py:902: SyntaxWarning: invalid escape sequence '\o'
  """
/lib/python3.12/site-packages/xrft/xrft.py:1012: SyntaxWarning: invalid escape sequence '\s'
  """
/lib/python3.12/site-packages/xrft/xrft.py:1088: SyntaxWarning: invalid escape sequence '\s'
  """
/lib/python3.12/site-packages/xrft/xrft.py:1174: SyntaxWarning: invalid escape sequence '\s'
  """

The corresponding doc strings should use raw string literals (r""" ... """) since they contain invalid escape sequences (I think for LaTeX content).

Thanks for your help!

juntyr avatar Mar 09 '25 07:03 juntyr