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.

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

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

Merged

Conversation

davecwright3
Copy link
Contributor

@davecwright3 davecwright3 commented Jul 30, 2024

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 skorch-dev/skorch#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

@ywx649999311
Copy link
Owner

Hi @davecwright3,

My apologies for the slow reply. First of all, thanks for catching this and make the PR. I will merge it!

@ywx649999311 ywx649999311 merged commit f27932f into ywx649999311:master Sep 18, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants