fix(utils.py): make docstring with latex raw #88
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
The docstring for
eztao.ts.utils.median_clip
currently contains an invalid string escape. When loaded withimportlib
viapytest
(and possibly an interaction frompoetry
?), tests fail oneztao
import. See below and skorch-dev/skorch#999 for examples.Fix
This PR makes the docstring raw and adds the
![image](https://private-user-images.githubusercontent.com/43979939/353633070-5870832d-4134-4e35-9b8a-3e589f752079.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzg4MTk4MDQsIm5iZiI6MTczODgxOTUwNCwicGF0aCI6Ii80Mzk3OTkzOS8zNTM2MzMwNzAtNTg3MDgzMmQtNDEzNC00ZTM1LTliOGEtM2U1ODlmNzUyMDc5LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMDYlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjA2VDA1MjUwNFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTM0YmRhYjgzNWU2YmU1Y2ZkMzcxZGRmM2UzNjc2ZTRlZjYzYjYwMGJkMTA4ZTIzZDZiOGMzMmIxNmIzZmZhOTkmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.WCaRY0GPu9pW5zMQPxUGSvXfG1fkELqwMdU2kM_TNO8)
:math:
directive. Here is the updated, rendered docstring.