Update docs to reflect field paths separated by '.' (flutter#629)

Firestore doc update.
jusst-engineering · Jul 26, 2018 · 217b6f2 · 217b6f2
1 parent b735d9a
commit 217b6f2
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/AUTHORS b/AUTHORS
@@ -15,3 +15,4 @@ Stefano Rodriguez <hlsroddy@gmail.com>
 Salvatore Giordano <salvatoregiordanoo@gmail.com>
 Brian Armstrong <brian@flutter.institute>
 Fabricio Nogueira <feufeu@gmail.com> 
+Simon Lightfoot <simon@devangels.london>
diff --git a/packages/cloud_firestore/lib/src/query.dart b/packages/cloud_firestore/lib/src/query.dart
@@ -97,7 +97,11 @@ class Query {
       new CollectionReference._(firestore, _pathComponents);
 
   /// Creates and returns a new [Query] with additional filter on specified
-  /// [field].
+  /// [field]. [field] refers to a field in a document.
+  ///
+  /// The [field] may consist of a single field name (referring to a top level
+  /// field in the document), or a series of field names seperated by dots '.'
+  /// (referring to a nested field in the document).
   ///
   /// Only documents satisfying provided condition are included in the result
   /// set.