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

[MRG] fix: make the documentation of _get_loss_unbalanced as a raw string #716

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

framunoz
Copy link
Contributor

@framunoz framunoz commented Jan 22, 2025

This is to avoid the following warning:

SyntaxWarning: invalid escape sequence '\m'

Types of changes

Add a r at the beggining of the _get_loss_unbalanced documentation

Motivation and context / Related issue

When I update the library, I realised that throws the following warning:

/home/.../site-packages/ot/unbalanced/_lbfgs.py:21: SyntaxWarning: invalid escape sequence '\m'
  """

How has this been tested (if it applies)

PR checklist

  • I have read the CONTRIBUTING document.
  • The documentation is up-to-date with the changes I made (check build artifacts).
  • All tests passed, and additional code has been covered with new tests.
  • I have added the PR and Issue fix to the RELEASES.md file.

This is to avoid the following warning:
SyntaxWarning: invalid escape sequence '\m'
@framunoz framunoz changed the title refactor: make the documentation of _get_loss_unbalanced as a raw string [MRG] refactor: make the documentation of _get_loss_unbalanced as a raw string Jan 22, 2025
@framunoz framunoz changed the title [MRG] refactor: make the documentation of _get_loss_unbalanced as a raw string [MRG] fix: make the documentation of _get_loss_unbalanced as a raw string Jan 28, 2025
* fix: add backslash to fix the error in the documentation

* refactor: delete space

* Update RELEASES.md

---------

Co-authored-by: Francisco Muñoz <[email protected]>
@framunoz
Copy link
Contributor Author

@rflamary the PR should be ready to be merge. This PR fixes a small warning introduced by a bug in the documentation of the latest version of POT.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant