From 9b356c9e97197006d9a0d74a2ad9eb099385de72 Mon Sep 17 00:00:00 2001 From: Fabian Joswig Date: Tue, 19 Apr 2022 13:13:45 +0100 Subject: [PATCH] docs: clarification on Corr.fit fitrange added. --- pyerrors/correlators.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/pyerrors/correlators.py b/pyerrors/correlators.py index ac3f8b07..6ddf3204 100644 --- a/pyerrors/correlators.py +++ b/pyerrors/correlators.py @@ -621,7 +621,7 @@ class Corr: raise Exception('Unknown variant.') def fit(self, function, fitrange=None, silent=False, **kwargs): - """Fits function to the data + r'''Fits function to the data Parameters ---------- @@ -629,10 +629,12 @@ class Corr: function to fit to the data. See fits.least_squares for details. fitrange : list Two element list containing the timeslices on which the fit is supposed to start and stop. + Caution: This range is inclusive as opposed to standard python indexing. + `fitrange=[4, 6]` corresponds to the three entries 4, 5 and 6. If not specified, self.prange or all timeslices are used. silent : bool Decides whether output is printed to the standard output. - """ + ''' if self.N != 1: raise Exception("Correlator must be projected before fitting")