Various documentation improvements

aviau · aviau · commit ca486fcb84c5 · 2015-04-11T12:01:08.000-04:00
diff --git a/docs/source/api-documentation.rst b/docs/source/api-documentation.rst
@@ -69,6 +69,8 @@ These clients are initiated in the same way as the
 :class:`ResultSet`
 -----------------------
 
+See the :ref:`resultset` page for more information.
+
 .. currentmodule:: influxdb.ResultSet
 .. autoclass:: influxdb.resultset.ResultSet
     :members:
diff --git a/docs/source/resultset.rst b/docs/source/resultset.rst
@@ -1,3 +1,6 @@
+
+.. _resultset:
+
 ================================
 Query response object: ResultSet
 ================================
diff --git a/influxdb/client.py b/influxdb/client.py
@@ -321,9 +321,9 @@ def write_points(self,
         :param points: A list of dicts.
         :param time_precision: [Optional, default None] Either 's', 'm', 'ms'
             or 'u'.
-        :param database The database to write the points to. Defaults to
+        :param database: The database to write the points to. Defaults to
             the client's current db.
-        :param retention_policy The retention policy for the points.
+        :param retention_policy: The retention policy for the points.
         """
         # TODO: re-implement chunks.
         return self._write_points(points=points,
diff --git a/influxdb/resultset.py b/influxdb/resultset.py
@@ -98,6 +98,9 @@ def __len__(self):
         return len(self.keys())
 
     def keys(self):
+        """
+        :return: List of keys. Keys are tuples (serie_name, tags)
+        """
         keys = []
         for serie in self._get_series():
             keys.append(
@@ -106,6 +109,9 @@ def keys(self):
         return keys
 
     def items(self):
+        """
+        :return: List of tuples, (key, generator)
+        """
         items = []
         for serie in self._get_series():
             serie_key = (serie.get('name', 'results'), serie.get('tags', None))
@@ -116,6 +122,12 @@ def items(self):
 
     @staticmethod
     def point_from_cols_vals(cols, vals):
+        """ Creates a dict from columns and values lists
+
+        :param cols: List of columns
+        :param vals: List of values
+        :return: Dict where keys are columns.
+        """
         point = {}
         for col_index, col_name in enumerate(cols):
             point[col_name] = vals[col_index]
