some docs changes

aboudreault · aboudreault · commit 7907d96d8c52 · 2016-07-29T12:29:31.000-04:00
diff --git a/cassandra/cqlengine/query.py b/cassandra/cqlengine/query.py
@@ -175,11 +175,6 @@ def __init__(self, batch_type=None, timestamp=None, consistency=None, execute_on
         self._context_entered = False
 
     def add_query(self, query):
-        """
-        Adds a query to the batch.
-
-        :param query: The query
-        """
         if not isinstance(query, BaseCQLStatement):
             raise CQLEngineException('only BaseCQLStatements can be added to a batch query')
         self.queries.append(query)
@@ -209,9 +204,6 @@ def add_callback(self, fn, *args, **kwargs):
         self._callbacks.append((fn, args, kwargs))
 
     def execute(self):
-        """
-        Executes the batch.
-        """
         if self._executed and self.warn_multiple_exec:
             msg = "Batch executed multiple times."
             if self._context_entered:
@@ -271,7 +263,7 @@ def __exit__(self, exc_type, exc_val, exc_tb):
 
 class ContextQuery(object):
     """
-    A Context manager to allow  a Model to switch context easily. Presently, the context only
+    A Context manager to allow a Model to switch context easily. Presently, the context only
     specifies a keyspace for model IO.
 
     For example:
@@ -289,7 +281,7 @@ class ContextQuery(object):
 
     def __init__(self, model, keyspace=None):
         """
-        :param model: A model
+        :param model: A model. This should be a class type, not an instance.
         :param keyspace: (optional) A keyspace name
         """
         from cassandra.cqlengine import models
diff --git a/docs/api/cassandra/cqlengine/query.rst b/docs/api/cassandra/cqlengine/query.rst
@@ -57,6 +57,9 @@ The methods here are used to filter, order, and constrain results.
 .. autoclass:: BatchQuery
    :members:
 
+   .. automethod:: add_query
+   .. automethod:: execute
+
 .. autoclass:: ContextQuery
 
 .. autoclass:: DoesNotExist
