Add WhiteListRRPolicy to API docs

2014-05-14 12:28:28 -05:00
parent 3abe119862
commit e22270cd29
2 changed files with 5 additions and 1 deletions
--- a/cassandra/policies.py
+++ b/cassandra/policies.py
@@ -394,7 +394,8 @@ class WhiteListRoundRobinPolicy(RoundRobinPolicy):
    """
    def __init__(self, hosts):
        """
-        :param hosts: List of hosts
+        The `hosts` parameter should be a sequence of hosts to permit
+        connections to.
        """
        self._allowed_hosts = hosts
        RoundRobinPolicy.__init__(self)
--- a/docs/api/cassandra/policies.rst
+++ b/docs/api/cassandra/policies.rst
@@ -18,6 +18,9 @@ Load Balancing
 .. autoclass:: DCAwareRoundRobinPolicy
   :members:

+.. autoclass:: WhiteListRoundRobinPolicy
+   :members:
+
 .. autoclass:: TokenAwarePolicy
   :members: