Merge pull request #282 from wedaly/sphinx-api-docs

Add Sphinx API docs

1 files changed, 6 insertions, 4 deletions

diff --git a/kafka/partitioner/base.py b/kafka/partitioner/base.py
index c62b7ed..0b1bb59 100644
--- a/kafka/partitioner/base.py
+++ b/kafka/partitioner/base.py
@@ -7,7 +7,8 @@ class Partitioner(object):
         """
         Initialize the partitioner
 
-        partitions - A list of available partitions (during startup)
+        Arguments:
+            partitions: A list of available partitions (during startup)
         """
         self.partitions = partitions
 
@@ -16,8 +17,9 @@ class Partitioner(object):
         Takes a string key and num_partitions as argument and returns
         a partition to be used for the message
 
-        partitions - The list of partitions is passed in every call. This
-                     may look like an overhead, but it will be useful
-                     (in future) when we handle cases like rebalancing
+        Arguments:
+            partitions: The list of partitions is passed in every call. This
+                may look like an overhead, but it will be useful
+                (in future) when we handle cases like rebalancing
         """
         raise NotImplementedError('partition function has to be implemented')