[skip ci] Added documentation

LaurentRDC · Jul 7, 2020 · 8bab32e · 8bab32e
1 parent 1b0096c
commit 8bab32e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -106,6 +106,7 @@ Fitting
 
     exponential
     biexponential
+    with_irf
 
 Non-uniform Fast Fourier Transform
 ----------------------------------

diff --git a/skued/time_series/fitting.py b/skued/time_series/fitting.py
@@ -123,6 +123,8 @@ def convolve(arr, kernel):
 
 # TODO: test with unevenly-spaced data points
 # TODO: figure out wth is going on with the width
+# TODO: add example
+# TODO: add example to user guide
 def with_irf(fwhm, f):
     """
     This decorator applies a Gaussian impulse response function (IRF) to a fitting function.