google/jaxopt

"invalid escape sequence" warning in `BoxOSQP` docstring

nardi opened this issue · 0 comments

Kind of a minor issue, but the lines

jaxopt/jaxopt/_src/osqp.py

Lines 333 to 336 in 501cc20

Dual Ineq variables: :math:`\mu, \phi`
ADMM computes :math:`y` at each iteration. :math:`\mu` and :math:`\phi` can be deduced from :math:`y`.

in the BoxOSQP docstring cause a DeprecationWarning: invalid escape sequence '\m'. Would changing them to

  Dual Ineq variables: :math:`\\mu, \\phi`


  ADMM computes :math:`y` at each iteration. :math:`\\mu` and :math:`\\phi` can be deduced from :math:`y`.

fix that while leaving the proper docstring in tact?

There is also another mistake in the same docstring:

If the inequality is one-sided then ``jnp.inf can be used for u,

Here ``jnp.inf does not have a closing ``.