Skip to content

Unicode fixes - #434

Merged
craffel merged 5 commits into
mainfrom
unicode-fixes
Feb 19, 2026
Merged

craffel merged 5 commits into
mainfrom
unicode-fixes

Conversation

@bmcfee

@bmcfee bmcfee commented Feb 19, 2026

Copy link
Copy Markdown
Collaborator

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.

@bmcfee bmcfee added this to the 0.9.0 milestone Feb 19, 2026
@bmcfee bmcfee added the bug label Feb 19, 2026
@bmcfee
bmcfee requested a review from Copilot February 19, 2026 20:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 \*\*kwargs escape sequences with backtick-formatted inline code in docstrings
  • Replaced :math:2\pi`` math directive with Unicode character 2π for "periodic" descriptions
  • Replaced 25\% escape sequence with plain 25% 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.

Comment thread mir_eval/util.py Outdated
Comment thread mir_eval/util.py Outdated
Comment thread mir_eval/util.py Outdated
Comment thread mir_eval/hierarchy.py Outdated
bmcfee and others added 3 commits February 19, 2026 15:11
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

codecov Bot commented Feb 19, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
unittests 85.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
mir_eval/beat.py 99.06% <ø> (ø)
mir_eval/hierarchy.py 100.00% <ø> (ø)
mir_eval/sonify.py 99.09% <ø> (ø)
mir_eval/util.py 98.01% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@craffel

craffel commented Feb 19, 2026

Copy link
Copy Markdown
Collaborator

Ok to merge?

@bmcfee

bmcfee commented Feb 19, 2026

Copy link
Copy Markdown
Collaborator Author

Yessir!

@craffel
craffel merged commit 27867b2 into main Feb 19, 2026
16 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

invalid escape sequence SyntaxWarnings in docstrings

3 participants