Unicode fixes - #434
Unicode fixes#434
Conversation
There was a problem hiding this comment.
Pull request overview
This PR fixes Python 3.12+ SyntaxWarnings caused by invalid escape sequences in docstrings across four files. The changes replace problematic escape sequences (like \*, \%, 2\pi) with either Unicode characters (π) or backtick-formatted inline code to address issue #426.
Changes:
- Replaced
\*\*kwargsescape sequences with backtick-formatted inline code in docstrings - Replaced
:math:2\pi`` math directive with Unicode character2πfor "periodic" descriptions - Replaced
25\%escape sequence with plain25%in documentation
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| mir_eval/util.py | Updated has_kwargs and filter_kwargs docstrings to use backticks instead of escaped asterisks |
| mir_eval/sonify.py | Replaced math directive with Unicode π character in two function docstrings |
| mir_eval/hierarchy.py | Updated evaluate function docstring to use backticks instead of escaped asterisks |
| mir_eval/beat.py | Fixed escaped percentage sign in module-level documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
|
Ok to merge? |
|
Yessir! |
Fixes #426. Very minor stuff here, just fixes to the points noted by @iansimon .
I've checked the doc build and it looks fine - i see no problems merging once this passes CI.