From b009cf673a3ccbac6d7f69e9e6363243bbc1f306 Mon Sep 17 00:00:00 2001
From: Jan Grewe <jan.grewe@g-node.org>
Date: Wed, 9 Oct 2019 11:41:04 +0200
Subject: [PATCH] [reproclasses/FICurve] add documentation

---
 fishbook/reproclasses.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/fishbook/reproclasses.py b/fishbook/reproclasses.py
index 95cfab3..9008604 100644
--- a/fishbook/reproclasses.py
+++ b/fishbook/reproclasses.py
@@ -357,10 +357,17 @@ class BoltzmannFit:
 
     @property
     def x_data(self):
+        """ The x data sorted and unique used for fitting.
+        :return: the x data
+        """
         return self.__x_sorted
 
     @property
     def y_data(self):
+        """
+        the Y data used for fitting, i.e. the average rate in the specified time window sorted by the x data.
+        :return: the average and the standard deviation of the y data
+        """
         return self.__y_avg, self.__y_err
 
     def solve(self, xvalues=None):