rlabbe / filterpy

Python Kalman filtering and optimal estimation library. Implements Kalman filter, particle filter, Extended Kalman filter, Unscented Kalman filter, g-h (alpha-beta), least squares, H Infinity, smoothers, and more. Has companion book 'Kalman and Bayesian Filters in Python'.
MIT License
3.22k stars 612 forks source link

DeprecationWarning: invalid escape sequence '\S' #300

Open rnestler opened 5 months ago

rnestler commented 5 months ago

I get a DeprecationWarning from filterpy/common/helpers.py:364

filterpy/common/helpers.py:364: DeprecationWarning: invalid escape sequence '\S'

It results from the invalid escape sequence in a docstring:

    """
    Computes the sum of the outer products of the rows in A and B

        P = \Sum {A[i] B[i].T} for i in 0..N
        ...
    """

I guess this is already fixed on master, since there it's using a raw docustring (r""")? But an easier fix would probably be to use "\Sum".