deepcharles / ruptures

ruptures: change point detection in Python
BSD 2-Clause "Simplified" License
1.6k stars 163 forks source link

docs(typo): Fixed syntax errors #250

Closed shanks847 closed 2 years ago

shanks847 commented 2 years ago

The breakpoint variable, 'bkps' was mispelt to 'b' in the line below signal, b = rpt.pw_constant(n, dim, n_bkps, noise_std=sigma) This resulted in in error when trying to display the true and estimated breakpoints Also the plotting function has extra brackets and a comma as seen below fig, (ax,) = rpt.display(signal, bkps, my_bkps, figsize=(10, 6)) This resulted in an integer iteration error. The fix(which encoprates the bkps spelling fix as well) is shown below fig, ax = rpt.display(signal, bkps, my_bkps, figsize=(10, 6))

deepcharles commented 2 years ago

Thanks.