From 19c97dc6f2ea1945234cde7ae4c17a481b2ab0e1 Mon Sep 17 00:00:00 2001
From: Alexander Minges <alexander.minges@hhu.de>
Date: Tue, 1 Sep 2015 16:02:30 +0200
Subject: [PATCH] More work on documentation

---
 analyze-cli.py          |  4 ++--
 libkinetics/__init__.py | 29 ++++++++++++++++++++++++++++-
 2 files changed, 30 insertions(+), 3 deletions(-)

diff --git a/analyze-cli.py b/analyze-cli.py
index 05cf462..cc477d3 100755
--- a/analyze-cli.py
+++ b/analyze-cli.py
@@ -141,8 +141,8 @@ class ExperimentHelper():
                 writer.writerow([])
                 writer.writerow(['HILL KINETICS'])
                 writer.writerow(['', 'value', 'std'])
-                writer.writerow(['vmax', exp.hill['vmax'],
-                                exp.hill['vmax_err']])
+                writer.writerow(['vmax', exp.hill['vmax'], exp.hill['vmax_err']
+                                 ])
                 writer.writerow(['Kprime', exp.hill['Kprime'],
                                  exp.hill['Kprime_err']])
                 writer.writerow(['h', exp.hill['h'], exp.hill['h_err']])
diff --git a/libkinetics/__init__.py b/libkinetics/__init__.py
index b7fa6c9..627e1cd 100644
--- a/libkinetics/__init__.py
+++ b/libkinetics/__init__.py
@@ -49,6 +49,16 @@ class Replicate():
     """
 
     def __init__(self, num, xy, owner):
+        """
+        Inits Replicate class with provided data.
+
+        Args:
+            logger: logging.Logger instance inherited by the owning Experiment.
+        xy: tuple of floats
+            time and signal to be analysed.
+        owner: object
+            measurement this measurement belongs to
+        """
         self.logger = owner.logger
         self.num = num + 1
         self.x, self.y = xy
@@ -57,7 +67,8 @@ class Replicate():
         self.fitresult = self.fit()
 
     def fit(self):
-        ind_min_max = np.where((self.x >= self.xlim[0]) & (self.x <= self.xlim[1]))
+        ind_min_max = np.where((self.x >= self.xlim[0]) & (self.x <=
+                                                           self.xlim[1]))
         x_for_fit = np.take(self.x, ind_min_max)
         y_for_fit = np.take(self.y, ind_min_max)
 
@@ -126,6 +137,22 @@ class Measurement():
     """
 
     def __init__(self, xy, conc, conc_unit, owner):
+        """
+        Inits Measurement class with provided data.
+
+        This is usually called from within an Experiment object.
+
+        Args:
+            logger: logging.Logger instance inherited by the owning Experiment.
+        concentration: float
+            substrate concentration associated with the measurement.
+        concentration_unit: string
+            unit of the concentration; only used for labeling plots/tables.
+        xy: tuple of floats
+            time and signal to be analysed.
+        owner: object
+            experiment this measurement belongs to
+        """
         self.logger = owner.logger
         self.concentration = float(conc)
         self.concentration_unit = conc_unit