search

ywx649999311 / EzTao

A Python Toolkit for AGN Time Series Analysis using CARMA models
MIT License
17 stars 9 forks source link

fix(utils.py): make docstring with latex raw #88

Open davecwright3 opened 1 month ago

davecwright3 commented 1 month ago

Issue

The docstring for eztao.ts.utils.median_clip currently contains an invalid string escape. When loaded with importlib via pytest (and possibly an interaction from poetry?), tests fail on eztao import. See below and https://github.com/skorch-dev/skorch/issues/999 for examples.

<path-to-eztao>/eztao/ts/__init__.py:1: in <module>
    from .utils import *
E     File "<path-to-eztao>/eztao/ts/utils.py", line 85
E       """Clip time series using a three point median filter.
E       ^^^
E   SyntaxError: invalid escape sequence '\s'

Fix

This PR makes the docstring raw and adds the :math: directive. Here is the updated, rendered docstring. image