Merge pull request #258 from tseaver/167-connection_save_entity

Fix #167: Update docstring for 'Connection.save_entity'.
googleapis · Oct 17, 2014 · be5edde · be5edde
2 parents 906700b + 8e40313
commit be5edde
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/gcloud/datastore/connection.py b/gcloud/datastore/connection.py
@@ -338,6 +338,11 @@ def commit(self, dataset_id, mutation_pb):
     def save_entity(self, dataset_id, key_pb, properties):
         """Save an entity to the Cloud Datastore with the provided properties.
 
+        .. note::
+           Any existing properties for the entity identified by 'key_pb'
+           will be replaced by those passed in 'properties';  properties
+           not passed in 'properties' no longer be set for the entity.
+
         :type dataset_id: string
         :param dataset_id: The dataset in which to save the entity.
 

diff --git a/gcloud/datastore/entity.py b/gcloud/datastore/entity.py
@@ -187,6 +187,12 @@ def reload(self):
     def save(self):
         """Save the entity in the Cloud Datastore.
 
+        .. note::
+           Any existing properties for the entity will be replaced by those
+           currently set on this instance.  Already-stored properties which do
+           not correspond to keys set on this instance will be removed from
+           the datastore.
+
         :rtype: :class:`gcloud.datastore.entity.Entity`
         :returns: The entity with a possibly updated Key.
         """