doc, Window-based change point detection - description of predict function

[gjaeger]

In the section "window-based change point detection" I noticed the following in window.py line 248:

    def predict(self, n_bkps=None, pen=None, epsilon=None):
        """Return the optimal breakpoints.
        Must be called after the fit method. The breakpoints are associated with the signal passed
        to fit().
        The stopping rule depends on the parameter passed to the function.
        Args:
            n_bkps (int): number of breakpoints to find before stopping.
            penalty (float): penalty value (>0)
            penalty (float): penalty value
        Returns:
            list: sorted list of breakpoints
        """

Should the arguments not be described as follows?

    def predict(self, n_bkps=None, pen=None, epsilon=None):
        """Return the optimal breakpoints.
        Must be called after the fit method. The breakpoints are associated with the signal passed
        to fit().
        The stopping rule depends on the parameter passed to the function.
        Args:
            n_bkps (int): number of breakpoints to find before stopping.
            pen (float): penalty value (>0)
            epsilon (float): reconstruction budget (>0)
        Returns:
            list: sorted list of breakpoints
        """

[deepcharles]

Yes you are right.
Would you mind making a pull request?
Many thanks

[deepcharles]

The online documentation will be updated on the next release. Thanks again.