Document to_legacy_urlsafe as being equivalent to ndb. (googleapis#3783)

landrito · Aug 22, 2017 · 8bca9ee · 8bca9ee
1 parent 3009f78
commit 8bca9ee
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/datastore/google/cloud/datastore/key.py b/datastore/google/cloud/datastore/key.py
@@ -307,6 +307,11 @@ def to_legacy_urlsafe(self):
         argument to ``ndb.Key(urlsafe=...)``. The base64 encoded values
         will have padding removed.
 
+        .. note::
+
+            The string returned by ``to_legacy_urlsafe`` is equivalent, but
+            not identical, to the string returned by ``ndb``.
+
         :rtype: bytes
         :returns: A bytestring containing the key encoded as URL-safe base64.
         """