Firestore field path from_string documentation (googleapis#5121)

chemelnucfin · tseaver · commit b5816762e8e4 · 2018-04-10T15:21:48.000-04:00
diff --git a/firestore/google/cloud/firestore_v1beta1/_helpers.py b/firestore/google/cloud/firestore_v1beta1/_helpers.py
@@ -137,6 +137,10 @@ def __repr__(self):
     def from_string(string):
         """ Creates a FieldPath from a unicode string representation.
 
+        This method splits on the character `.` and disallows the
+        characters `~*/[]`. To create a FieldPath whose components have
+        those characters, call the constructor.
+
         Args:
             :type string: str
             :param string: A unicode string which cannot contain
