google-cloud-firestore 0.24.1 → 0.24.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fccde9d0d32a88be624c95255dcdcbede69be371428e9f5dc3d7e6e4b59b541
-  data.tar.gz: a761abb15eb952a1f555746f8fe2a0ebe2e821954c4f65e55711a270c2c903de
+  metadata.gz: a5ba1c47b78cf38ed102313b8069a1cd53404c7a46982fcbd9ec431d824c3b7e
+  data.tar.gz: 14bdfd709f1e330991d638d40cdb822e173247bc5504c13890a47ce78efc568c
 SHA512:
-  metadata.gz: 54d896bf21cffe74009963af0d9a2eebbe187e4e27f1ba4dff85ecc933790e506fb0d3f5729dfc7600dbe3c9a10f14f9729b1e7d494c5944534b1a4444fff33c
-  data.tar.gz: 162b854a6bdfe533535b4626b0b3a3669b8c8aa159c21279bb42ec333da840e87d6d32d147e350c5f335aa62a8b883e21491ba46498d9afd1ff1ff84b8d6ae50
+  metadata.gz: 871dfc5e79e50134cf47f13cf4c17eae85d12aa0724782d2db56401da2d8f543aded7162ede2c19067cf9d992364aa631dd2ef6a3d82281d24fc0f80ee3d35f7
+  data.tar.gz: 7cc1808bf7bd93503748619b96db974d14f9780afa6c9b7790a83943220337df4c51eaace902b4f176d7300a0270da5bbde5181998421f2e42d8014bb3917fb8

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History
 
+### 0.24.2 / 2018-09-20
+
+* Add fix for comparing NaN values
+  * NaN values should not be compared, as this may raise with Active Support.
+* Update documentation.
+  * Change documentation URL to googleapis GitHub org.
+* Fix circular require warning.
+
 ### 0.24.1 / 2018-09-12
 
 * Add missing documentation files to package.

data/LOGGING.md

@@ -5,7 +5,7 @@ To enable logging for this library, set the logger for the underlying
 that you set may be a Ruby stdlib
 [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
 shown below, or a
-[`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
+[`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
 that will write logs to [Stackdriver
 Logging](https://cloud.google.com/logging/). See
 [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)

data/lib/google-cloud-firestore.rb

@@ -20,7 +20,7 @@
 
 
 gem "google-cloud-core"
-require "google/cloud"
+require "google/cloud" unless defined? Google::Cloud.new
 require "google/cloud/config"
 require "googleauth"
 

data/lib/google/cloud/firestore/field_value.rb

@@ -163,7 +163,7 @@ module Google
         def self.array_union *values
           # We can flatten the values because arrays don't support sub-arrays
           values.flatten!
-          raise ArgumentError, "values must be provided" if values.nil?
+          raise ArgumentError, "values must be provided" if values.empty?
           # verify the values are the correct types
           Convert.raw_to_value values
 
@@ -196,7 +196,7 @@ module Google
         def self.array_delete *values
           # We can flatten the values because arrays don't support sub-arrays
           values.flatten!
-          raise ArgumentError, "values must be provided" if values.nil?
+          raise ArgumentError, "values must be provided" if values.empty?
           # verify the values are the correct types
           Convert.raw_to_value values
 

data/lib/google/cloud/firestore/query.rb

@@ -921,32 +921,33 @@ module Google
           GREATER_THAN
           GREATER_THAN_OR_EQUAL
         ].freeze
-        ##
-        # @private
-        UNARY_NIL_VALUES = [nil, :null, :nil].freeze
-        ##
-        # @private
-        UNARY_NAN_VALUES = [:nan, Float::NAN].freeze
-        ##
-        # @private
-        UNARY_VALUES = (UNARY_NIL_VALUES + UNARY_NAN_VALUES).freeze
+
+        def value_nil? value
+          [nil, :null, :nil].include?(value)
+        end
+
+        def value_nan? value
+          # Comparing NaN values raises, so check for #nan? first.
+          return true if value.respond_to?(:nan?) && value.nan?
+          [:nan].include?(value)
+        end
+
+        def value_unary? value
+          value_nil?(value) || value_nan?(value)
+        end
 
         def filter name, op, value
           field = StructuredQuery::FieldReference.new field_path: name.to_s
           operator = FILTER_OPS[op.to_s.downcase]
           raise ArgumentError, "unknown operator #{op}" if operator.nil?
 
-          is_value_nan = value.respond_to?(:nan?) && value.nan?
-          if UNARY_VALUES.include?(value) || is_value_nan
+          if value_unary? value
             if operator != :EQUAL
               raise ArgumentError,
                     "can only check equality for #{value} values"
             end
 
-            operator = :IS_NULL
-            if UNARY_NAN_VALUES.include?(value) || is_value_nan
-              operator = :IS_NAN
-            end
+            operator = value_nan?(value) ? :IS_NAN : :IS_NULL
 
             return StructuredQuery::Filter.new(unary_filter:
               StructuredQuery::UnaryFilter.new(field: field, op: operator))

data/lib/google/cloud/firestore/v1beta1.rb

@@ -21,7 +21,7 @@ module Google
       # rubocop:disable LineLength
 
       ##
-      # # Ruby Client for Google Cloud Firestore API ([Beta](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+      # # Ruby Client for Google Cloud Firestore API ([Beta](https://github.com/googleapis/google-cloud-ruby#versioning))
       #
       # [Google Cloud Firestore API][Product Documentation]:
       #
@@ -34,7 +34,7 @@ module Google
       # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
       # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
       # 3. [Enable the Google Cloud Firestore API.](https://console.cloud.google.com/apis/library/firestore.googleapis.com)
-      # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+      # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
       #
       # ### Installation
       # ```
@@ -44,7 +44,7 @@ module Google
       # ### Next Steps
       # - Read the [Google Cloud Firestore API Product documentation][Product Documentation]
       #   to learn more about the product and see How-to Guides.
-      # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+      # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
       #   to see the full list of Cloud APIs that we cover.
       #
       # [Product Documentation]: https://cloud.google.com/firestore
@@ -53,7 +53,7 @@ module Google
       #
       # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
       # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
-      # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+      # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
       # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
       # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
       #
@@ -83,17 +83,17 @@ module Google
         #
         # This service exposes several types of comparable timestamps:
         #
-        # * +create_time+ - The time at which a document was created. Changes only
+        # * `create_time` - The time at which a document was created. Changes only
         #   when a document is deleted, then re-created. Increases in a strict
         #   monotonic fashion.
-        # * +update_time+ - The time at which a document was last updated. Changes
+        # * `update_time` - The time at which a document was last updated. Changes
         #   every time a document is modified. Does not change when a write results
         #   in no modifications. Increases in a strict monotonic fashion.
-        # * +read_time+ - The time at which a particular state was observed. Used
+        # * `read_time` - The time at which a particular state was observed. Used
         #   to denote a consistent snapshot of the database or the time at which a
         #   Document was observed to not exist.
-        # * +commit_time+ - The time at which the writes in a transaction were
-        #   committed. Any read with an equal or greater +read_time+ is guaranteed
+        # * `commit_time` - The time at which the writes in a transaction were
+        #   committed. Any read with an equal or greater `read_time` is guaranteed
         #   to see the effects of the transaction.
         #
         # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]

data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/common.rb

@@ -30,8 +30,8 @@ module Google
       # A precondition on a document, used for conditional operations.
       # @!attribute [rw] exists
       #   @return [true, false]
-      #     When set to +true+, the target document must exist.
-      #     When set to +false+, the target document must not exist.
+      #     When set to `true`, the target document must exist.
+      #     When set to `false`, the target document must not exist.
       # @!attribute [rw] update_time
       #   @return [Google::Protobuf::Timestamp]
       #     When set, the target document must exist and have been last updated at

data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/document.rb

@@ -22,47 +22,47 @@ module Google
       # @!attribute [rw] name
       #   @return [String]
       #     The resource name of the document, for example
-      #     +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
+      #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
       # @!attribute [rw] fields
       #   @return [Hash{String => Google::Firestore::V1beta1::Value}]
       #     The document's fields.
       #
       #     The map keys represent field names.
       #
-      #     A simple field name contains only characters +a+ to +z+, +A+ to +Z+,
-      #     +0+ to +9+, or +_+, and must not start with +0+ to +9+. For example,
-      #     +foo_bar_17+.
+      #     A simple field name contains only characters `a` to `z`, `A` to `Z`,
+      #     `0` to `9`, or `_`, and must not start with `0` to `9`. For example,
+      #     `foo_bar_17`.
       #
-      #     Field names matching the regular expression +__.*__+ are reserved. Reserved
+      #     Field names matching the regular expression `__.*__` are reserved. Reserved
       #     field names are forbidden except in certain documented contexts. The map
       #     keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be
       #     empty.
       #
       #     Field paths may be used in other contexts to refer to structured fields
-      #     defined here. For +map_value+, the field path is represented by the simple
-      #     or quoted field names of the containing fields, delimited by +.+. For
+      #     defined here. For `map_value`, the field path is represented by the simple
+      #     or quoted field names of the containing fields, delimited by `.`. For
       #     example, the structured field
-      #     +"foo" : { map_value: { "x&y" : { string_value: "hello" }}}+ would be
-      #     represented by the field path +foo.x&y+.
+      #     `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be
+      #     represented by the field path `foo.x&y`.
       #
-      #     Within a field path, a quoted field name starts and ends with + + + and
-      #     may contain any character. Some characters, including + + +, must be
-      #     escaped using a +\+. For example, + +x&y+ + represents +x&y+ and
-      #     + +bak\+tik+ + represents + bak+tik +.
+      #     Within a field path, a quoted field name starts and ends with `` ` `` and
+      #     may contain any character. Some characters, including `` ` ``, must be
+      #     escaped using a `\`. For example, `` `x&y` `` represents `x&y` and
+      #     `` `bak\`tik` `` represents `` bak`tik ``.
       # @!attribute [rw] create_time
       #   @return [Google::Protobuf::Timestamp]
       #     Output only. The time at which the document was created.
       #
       #     This value increases monotonically when a document is deleted then
       #     recreated. It can also be compared to values from other documents and
-      #     the +read_time+ of a query.
+      #     the `read_time` of a query.
       # @!attribute [rw] update_time
       #   @return [Google::Protobuf::Timestamp]
       #     Output only. The time at which the document was last changed.
       #
-      #     This value is initially set to the +create_time+ then increases
+      #     This value is initially set to the `create_time` then increases
       #     monotonically with each change to the document. It can also be
-      #     compared to values from other documents and the +read_time+ of a query.
+      #     compared to values from other documents and the `read_time` of a query.
       class Document; end
 
       # A message that can hold any of the supported value types.
@@ -100,7 +100,7 @@ module Google
       # @!attribute [rw] reference_value
       #   @return [String]
       #     A reference to a document. For example:
-      #     +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
+      #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
       # @!attribute [rw] geo_point_value
       #   @return [Google::Type::LatLng]
       #     A geo point value representing a point on the surface of Earth.
@@ -127,7 +127,7 @@ module Google
       #     The map's fields.
       #
       #     The map keys represent field names. Field names matching the regular
-      #     expression +__.*__+ are reserved. Reserved field names are forbidden except
+      #     expression `__.*__` are reserved. Reserved field names are forbidden except
       #     in certain documented contexts. The map keys, represented as UTF-8, must
       #     not exceed 1,500 bytes and cannot be empty.
       class MapValue; end

data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb

@@ -20,7 +20,7 @@ module Google
       # @!attribute [rw] name
       #   @return [String]
       #     The resource name of the Document to get. In the format:
-      #     +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
+      #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
       # @!attribute [rw] mask
       #   @return [Google::Firestore::V1beta1::DocumentMask]
       #     The fields to return. If not set, returns all fields.
@@ -40,24 +40,24 @@ module Google
       # @!attribute [rw] parent
       #   @return [String]
       #     The parent resource name. In the format:
-      #     +projects/\\{project_id}/databases/\\{database_id}/documents+ or
-      #     +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
+      #     `projects/{project_id}/databases/{database_id}/documents` or
+      #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
       #     For example:
-      #     +projects/my-project/databases/my-database/documents+ or
-      #     +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
+      #     `projects/my-project/databases/my-database/documents` or
+      #     `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
       # @!attribute [rw] collection_id
       #   @return [String]
-      #     The collection ID, relative to +parent+, to list. For example: +chatrooms+
-      #     or +messages+.
+      #     The collection ID, relative to `parent`, to list. For example: `chatrooms`
+      #     or `messages`.
       # @!attribute [rw] page_size
       #   @return [Integer]
       #     The maximum number of documents to return.
       # @!attribute [rw] page_token
       #   @return [String]
-      #     The +next_page_token+ value returned from a previous List request, if any.
+      #     The `next_page_token` value returned from a previous List request, if any.
       # @!attribute [rw] order_by
       #   @return [String]
-      #     The order to sort results by. For example: +priority desc, name+.
+      #     The order to sort results by. For example: `priority desc, name`.
       # @!attribute [rw] mask
       #   @return [Google::Firestore::V1beta1::DocumentMask]
       #     The fields to return. If not set, returns all fields.
@@ -78,8 +78,8 @@ module Google
       #     be returned with a key but will not have fields, {Google::Firestore::V1beta1::Document#create_time Document#create_time},
       #     or {Google::Firestore::V1beta1::Document#update_time Document#update_time} set.
       #
-      #     Requests with +show_missing+ may not specify +where+ or
-      #     +order_by+.
+      #     Requests with `show_missing` may not specify `where` or
+      #     `order_by`.
       class ListDocumentsRequest; end
 
       # The response for {Google::Firestore::V1beta1::Firestore::ListDocuments Firestore::ListDocuments}.
@@ -95,11 +95,11 @@ module Google
       # @!attribute [rw] parent
       #   @return [String]
       #     The parent resource. For example:
-      #     +projects/\\{project_id}/databases/\\{database_id}/documents+ or
-      #     +projects/\\{project_id}/databases/\\{database_id}/documents/chatrooms/\\{chatroom_id}+
+      #     `projects/{project_id}/databases/{database_id}/documents` or
+      #     `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
       # @!attribute [rw] collection_id
       #   @return [String]
-      #     The collection ID, relative to +parent+, to list. For example: +chatrooms+.
+      #     The collection ID, relative to `parent`, to list. For example: `chatrooms`.
       # @!attribute [rw] document_id
       #   @return [String]
       #     The client-assigned document ID to use for this document.
@@ -107,7 +107,7 @@ module Google
       #     Optional. If not specified, an ID will be assigned by the service.
       # @!attribute [rw] document
       #   @return [Google::Firestore::V1beta1::Document]
-      #     The document to create. +name+ must not be set.
+      #     The document to create. `name` must not be set.
       # @!attribute [rw] mask
       #   @return [Google::Firestore::V1beta1::DocumentMask]
       #     The fields to return. If not set, returns all fields.
@@ -146,7 +146,7 @@ module Google
       # @!attribute [rw] name
       #   @return [String]
       #     The resource name of the Document to delete. In the format:
-      #     +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
+      #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
       # @!attribute [rw] current_document
       #   @return [Google::Firestore::V1beta1::Precondition]
       #     An optional precondition on the document.
@@ -157,13 +157,13 @@ module Google
       # @!attribute [rw] database
       #   @return [String]
       #     The database name. In the format:
-      #     +projects/\\{project_id}/databases/\\{database_id}+.
+      #     `projects/{project_id}/databases/{database_id}`.
       # @!attribute [rw] documents
       #   @return [Array<String>]
       #     The names of the documents to retrieve. In the format:
-      #     +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
+      #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
       #     The request will fail if any of the document is not a child resource of the
-      #     given +database+. Duplicate names will be elided.
+      #     given `database`. Duplicate names will be elided.
       # @!attribute [rw] mask
       #   @return [Google::Firestore::V1beta1::DocumentMask]
       #     The fields to return. If not set, returns all fields.
@@ -192,7 +192,7 @@ module Google
       # @!attribute [rw] missing
       #   @return [String]
       #     A document name that was requested but does not exist. In the format:
-      #     +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
+      #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
       # @!attribute [rw] transaction
       #   @return [String]
       #     The transaction that was started as part of this request.
@@ -210,7 +210,7 @@ module Google
       # @!attribute [rw] database
       #   @return [String]
       #     The database name. In the format:
-      #     +projects/\\{project_id}/databases/\\{database_id}+.
+      #     `projects/{project_id}/databases/{database_id}`.
       # @!attribute [rw] options
       #   @return [Google::Firestore::V1beta1::TransactionOptions]
       #     The options for the transaction.
@@ -227,7 +227,7 @@ module Google
       # @!attribute [rw] database
       #   @return [String]
       #     The database name. In the format:
-      #     +projects/\\{project_id}/databases/\\{database_id}+.
+      #     `projects/{project_id}/databases/{database_id}`.
       # @!attribute [rw] writes
       #   @return [Array<Google::Firestore::V1beta1::Write>]
       #     The writes to apply.
@@ -254,7 +254,7 @@ module Google
       # @!attribute [rw] database
       #   @return [String]
       #     The database name. In the format:
-      #     +projects/\\{project_id}/databases/\\{database_id}+.
+      #     `projects/{project_id}/databases/{database_id}`.
       # @!attribute [rw] transaction
       #   @return [String]
       #     The transaction to roll back.
@@ -264,11 +264,11 @@ module Google
       # @!attribute [rw] parent
       #   @return [String]
       #     The parent resource name. In the format:
-      #     +projects/\\{project_id}/databases/\\{database_id}/documents+ or
-      #     +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
+      #     `projects/{project_id}/databases/{database_id}/documents` or
+      #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
       #     For example:
-      #     +projects/my-project/databases/my-database/documents+ or
-      #     +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
+      #     `projects/my-project/databases/my-database/documents` or
+      #     `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
       # @!attribute [rw] structured_query
       #   @return [Google::Firestore::V1beta1::StructuredQuery]
       #     A structured query.
@@ -302,10 +302,10 @@ module Google
       #   @return [Google::Protobuf::Timestamp]
       #     The time at which the document was read. This may be monotonically
       #     increasing; in this case, the previous documents in the result stream are
-      #     guaranteed not to have changed between their +read_time+ and this one.
+      #     guaranteed not to have changed between their `read_time` and this one.
       #
-      #     If the query returns no results, a response with +read_time+ and no
-      #     +document+ will be sent, and this represents the time at which the query
+      #     If the query returns no results, a response with `read_time` and no
+      #     `document` will be sent, and this represents the time at which the query
       #     was run.
       # @!attribute [rw] skipped_results
       #   @return [Integer]
@@ -326,7 +326,7 @@ module Google
       # @!attribute [rw] database
       #   @return [String]
       #     The database name. In the format:
-      #     +projects/\\{project_id}/databases/\\{database_id}+.
+      #     `projects/{project_id}/databases/{database_id}`.
       #     This is only required in the first message.
       # @!attribute [rw] stream_id
       #   @return [String]
@@ -354,7 +354,7 @@ module Google
       #     responses.
       #
       #     Leave this field unset when creating a new stream. To resume a stream at
-      #     a specific point, set this field and the +stream_id+ field.
+      #     a specific point, set this field and the `stream_id` field.
       #
       #     Leave this field unset when creating a new stream.
       # @!attribute [rw] labels
@@ -388,7 +388,7 @@ module Google
       # @!attribute [rw] database
       #   @return [String]
       #     The database name. In the format:
-      #     +projects/\\{project_id}/databases/\\{database_id}+.
+      #     `projects/{project_id}/databases/{database_id}`.
       # @!attribute [rw] add_target
       #   @return [Google::Firestore::V1beta1::Target]
       #     A target to add to this stream.
@@ -437,7 +437,7 @@ module Google
       #     Using a resume token with a different target is unsupported and may fail.
       # @!attribute [rw] read_time
       #   @return [Google::Protobuf::Timestamp]
-      #     Start listening after a specific +read_time+.
+      #     Start listening after a specific `read_time`.
       #
       #     The client must know the state of matching documents at this time.
       # @!attribute [rw] target_id
@@ -458,20 +458,20 @@ module Google
         # @!attribute [rw] documents
         #   @return [Array<String>]
         #     The names of the documents to retrieve. In the format:
-        #     +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
+        #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
         #     The request will fail if any of the document is not a child resource of
-        #     the given +database+. Duplicate names will be elided.
+        #     the given `database`. Duplicate names will be elided.
         class DocumentsTarget; end
 
         # A target specified by a query.
         # @!attribute [rw] parent
         #   @return [String]
         #     The parent resource name. In the format:
-        #     +projects/\\{project_id}/databases/\\{database_id}/documents+ or
-        #     +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
+        #     `projects/{project_id}/databases/{database_id}/documents` or
+        #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
         #     For example:
-        #     +projects/my-project/databases/my-database/documents+ or
-        #     +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
+        #     `projects/my-project/databases/my-database/documents` or
+        #     `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
         # @!attribute [rw] structured_query
         #   @return [Google::Firestore::V1beta1::StructuredQuery]
         #     A structured query.
@@ -488,7 +488,7 @@ module Google
       #
       #     If empty, the change applies to all targets.
       #
-      #     For +target_change_type=ADD+, the order of the target IDs matches the order
+      #     For `target_change_type=ADD`, the order of the target IDs matches the order
       #     of the requests to add the targets. This allows clients to unambiguously
       #     associate server-assigned target IDs with added targets.
       #
@@ -498,26 +498,26 @@ module Google
       #     The error that resulted in this change, if applicable.
       # @!attribute [rw] resume_token
       #   @return [String]
-      #     A token that can be used to resume the stream for the given +target_ids+,
-      #     or all targets if +target_ids+ is empty.
+      #     A token that can be used to resume the stream for the given `target_ids`,
+      #     or all targets if `target_ids` is empty.
       #
       #     Not set on every target change.
       # @!attribute [rw] read_time
       #   @return [Google::Protobuf::Timestamp]
-      #     The consistent +read_time+ for the given +target_ids+ (omitted when the
+      #     The consistent `read_time` for the given `target_ids` (omitted when the
       #     target_ids are not at a consistent snapshot).
       #
-      #     The stream is guaranteed to send a +read_time+ with +target_ids+ empty
+      #     The stream is guaranteed to send a `read_time` with `target_ids` empty
       #     whenever the entire stream reaches a new consistent snapshot. ADD,
       #     CURRENT, and RESET messages are guaranteed to (eventually) result in a
       #     new consistent snapshot (while NO_CHANGE and REMOVE messages are not).
       #
-      #     For a given stream, +read_time+ is guaranteed to be monotonically
+      #     For a given stream, `read_time` is guaranteed to be monotonically
       #     increasing.
       class TargetChange
         # The type of change.
         module TargetChangeType
-          # No change has occurred. Used only to send an updated +resume_token+.
+          # No change has occurred. Used only to send an updated `resume_token`.
           NO_CHANGE = 0
 
           # The targets have been added.
@@ -529,7 +529,7 @@ module Google
           # The targets reflect all changes committed before the targets were added
           # to the stream.
           #
-          # This will be sent after or with a +read_time+ that is greater than or
+          # This will be sent after or with a `read_time` that is greater than or
           # equal to the time at which the targets were added.
           #
           # Listeners can wait for this change if read-after-write semantics
@@ -539,8 +539,8 @@ module Google
           # The targets have been reset, and a new initial state for the targets
           # will be returned in subsequent changes.
           #
-          # After the initial state is complete, +CURRENT+ will be returned even
-          # if the target was previously indicated to be +CURRENT+.
+          # After the initial state is complete, `CURRENT` will be returned even
+          # if the target was previously indicated to be `CURRENT`.
           RESET = 4
         end
       end
@@ -549,9 +549,9 @@ module Google
       # @!attribute [rw] parent
       #   @return [String]
       #     The parent document. In the format:
-      #     +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
+      #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
       #     For example:
-      #     +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
+      #     `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
       # @!attribute [rw] page_size
       #   @return [Integer]
       #     The maximum number of results to return.