Note protobuf RPCs mapped by connection methods.

tseaver · tseaver · commit 162f508466d9 · 2014-10-27T18:00:48.000-04:00
Remove section header comments, per @dhermes feedback.
diff --git a/gcloud/datastore/connection.py b/gcloud/datastore/connection.py
@@ -153,12 +153,11 @@ def dataset(self, *args, **kwargs):
         kwargs['connection'] = self
         return Dataset(*args, **kwargs)
 
-    #
-    #   Protobuf RPCs for DatastoreService
-    #
     def lookup(self, dataset_id, key_pbs):
         """Lookup keys from a dataset in the Cloud Datastore.
 
+        Maps the ``DatastoreService.Lookup`` protobuf RPC.
+
         This method deals only with protobufs
         (:class:`gcloud.datastore.datastore_v1_pb2.Key`
         and
@@ -223,6 +222,8 @@ def lookup(self, dataset_id, key_pbs):
     def run_query(self, dataset_id, query_pb, namespace=None):
         """Run a query on the Cloud Datastore.
 
+        Maps the ``DatastoreService.RunQuery`` protobuf RPC.
+
         Given a Query protobuf,
         sends a ``runQuery`` request to the Cloud Datastore API
         and returns a list of entity protobufs matching the query.
@@ -277,6 +278,8 @@ def run_query(self, dataset_id, query_pb, namespace=None):
     def begin_transaction(self, dataset_id, serializable=False):
         """Begin a transaction.
 
+        Maps the ``DatastoreService.BeginTransaction`` protobuf RPC.
+
         :type dataset_id: string
         :param dataset_id: The dataset over which to execute the transaction.
         """
@@ -302,6 +305,8 @@ def begin_transaction(self, dataset_id, serializable=False):
     def commit(self, dataset_id, mutation_pb):
         """Commit dataset mutations in context of current transation (if any).
 
+        Maps the ``DatastoreService.Commit`` protobuf RPC.
+
         :type dataset_id: string
         :param dataset_id: The dataset in which to perform the changes.
 
@@ -327,6 +332,8 @@ def commit(self, dataset_id, mutation_pb):
     def rollback(self, dataset_id):
         """Rollback the connection's existing transaction.
 
+        Maps the ``DatastoreService.Rollback`` protobuf RPC.
+
         Raises a ``ValueError``
         if the connection isn't currently in a transaction.
 
@@ -345,6 +352,8 @@ def rollback(self, dataset_id):
     def allocate_ids(self, dataset_id, key_pbs):
         """Obtain backend-generated IDs for a set of keys.
 
+        Maps the ``DatastoreService.AllocateIds`` protobuf RPC.
+
         :type dataset_id: string
         :param dataset_id: The dataset to which the transaction belongs.
 
@@ -362,9 +371,6 @@ def allocate_ids(self, dataset_id, key_pbs):
                              datastore_pb.AllocateIdsResponse)
         return list(response.key)
 
-    #
-    #   Entity-related helper methods.
-    #
     def save_entity(self, dataset_id, key_pb, properties):
         """Save an entity to the Cloud Datastore with the provided properties.
 
