query.rb in google-cloud-firestore-0.24.2

- old
+ new

@@ -30,24 +30,24 @@
       #   @return [Array<Google::Firestore::V1beta1::StructuredQuery::Order>]
       #     The order to apply to the query results.
       #
       #     Firestore guarantees a stable ordering through the following rules:
       #
-      #     * Any field required to appear in +order_by+, that is not already
-      #       specified in +order_by+, is appended to the order in field name order
+      #     * Any field required to appear in `order_by`, that is not already
+      #       specified in `order_by`, is appended to the order in field name order
       #       by default.
-      #     * If an order on +__name__+ is not specified, it is appended by default.
+      #     * If an order on `__name__` is not specified, it is appended by default.
       #
       #     Fields are appended with the same sort direction as the last order
       #     specified, or 'ASCENDING' if no order was specified. For example:
       #
-      #     * +SELECT * FROM Foo ORDER BY A+ becomes
-      #       +SELECT * FROM Foo ORDER BY A, __name__+
-      #     * +SELECT * FROM Foo ORDER BY A DESC+ becomes
-      #       +SELECT * FROM Foo ORDER BY A DESC, __name__ DESC+
-      #     * +SELECT * FROM Foo WHERE A > 1+ becomes
-      #       +SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__+
+      #     * `SELECT * FROM Foo ORDER BY A` becomes
+      #       `SELECT * FROM Foo ORDER BY A, __name__`
+      #     * `SELECT * FROM Foo ORDER BY A DESC` becomes
+      #       `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`
+      #     * `SELECT * FROM Foo WHERE A > 1` becomes
+      #       `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__`
       # @!attribute [rw] start_at
       #   @return [Google::Firestore::V1beta1::Cursor]
       #     A starting point for the query results.
       # @!attribute [rw] end_at
       #   @return [Google::Firestore::V1beta1::Cursor]
@@ -63,19 +63,19 @@
       #     The maximum number of results to return.
       #
       #     Applies after all other constraints.
       #     Must be >= 0 if specified.
       class StructuredQuery
-        # A selection of a collection, such as +messages as m1+.
+        # A selection of a collection, such as `messages as m1`.
         # @!attribute [rw] collection_id
         #   @return [String]
         #     The collection ID.
         #     When set, selects only collections with this ID.
         # @!attribute [rw] all_descendants
         #   @return [true, false]
         #     When false, selects only collections that are immediate children of
-        #     the +parent+ specified in the containing +RunQueryRequest+.
+        #     the `parent` specified in the containing `RunQueryRequest`.
         #     When true, selects all descendant collections.
         class CollectionSelector; end
 
         # A filter.
         # @!attribute [rw] composite_filter
@@ -122,21 +122,21 @@
           # A field filter operator.
           module Operator
             # Unspecified. This value must not be used.
             OPERATOR_UNSPECIFIED = 0
 
-            # Less than. Requires that the field come first in +order_by+.
+            # Less than. Requires that the field come first in `order_by`.
             LESS_THAN = 1
 
-            # Less than or equal. Requires that the field come first in +order_by+.
+            # Less than or equal. Requires that the field come first in `order_by`.
             LESS_THAN_OR_EQUAL = 2
 
-            # Greater than. Requires that the field come first in +order_by+.
+            # Greater than. Requires that the field come first in `order_by`.
             GREATER_THAN = 3
 
             # Greater than or equal. Requires that the field come first in
-            # +order_by+.
+            # `order_by`.
             GREATER_THAN_OR_EQUAL = 4
 
             # Equal.
             EQUAL = 5
 
@@ -170,24 +170,24 @@
         # @!attribute [rw] field
         #   @return [Google::Firestore::V1beta1::StructuredQuery::FieldReference]
         #     The field to order by.
         # @!attribute [rw] direction
         #   @return [Google::Firestore::V1beta1::StructuredQuery::Direction]
-        #     The direction to order by. Defaults to +ASCENDING+.
+        #     The direction to order by. Defaults to `ASCENDING`.
         class Order; end
 
-        # A reference to a field, such as +max(messages.time) as max_time+.
+        # A reference to a field, such as `max(messages.time) as max_time`.
         # @!attribute [rw] field_path
         #   @return [String]
         class FieldReference; end
 
         # The projection of document's fields to return.
         # @!attribute [rw] fields
         #   @return [Array<Google::Firestore::V1beta1::StructuredQuery::FieldReference>]
         #     The fields to return.
         #
         #     If empty, all fields are returned. To only return the name
-        #     of the document, use +['__name__']+.
+        #     of the document, use `['__name__']`.
         class Projection; end
 
         # A sort direction.
         module Direction
           # Unspecified.
\ No newline at end of file