GO-Eratosthenes/dhdt

Deprecation warnings from docstrings with math

Closed this issue · 0 comments

Docstrings that include backslashes (e.g. docstrings containing formulas) give deprecation warnings, see e.g.:

/home/eratosthenes-fnattino/dhdt/dhdt/processing/matching_tools_differential.py:101: DeprecationWarning: invalid escape sequence \p

The docstring convention seems to suggest that raw strings should be used (r""" ... """):

Use r"""raw triple double quotes""" if you use any backslashes in your docstrings.