Skip to content

Commit

Permalink
Fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
@comandeo-mongo
comandeo-mongo committed Jul 5, 2024
1 parent 9a18b6d commit d1bf06e
Show file tree
Hide file tree
Showing 12 changed files with 57 additions and 57 deletions.
6 changes: 3 additions & 3 deletions lib/mongo/client.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ def hash
# validation. This setting overrides :ssl_verify with respect to whether hostname validation
# is performed.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the feature is not enabled.
# @option options [ true, false ] :truncate_logs Whether to truncate the
# logs at the default 250 characters.
Expand Down Expand Up @@ -943,7 +943,7 @@ def reconnect
# @option opts [ Object ] :comment A user-provided
# comment to attach to this command.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the feature is not enabled.
#
# @return [ Array<String> ] The names of the databases.
Expand All @@ -968,7 +968,7 @@ def database_names(filter = {}, opts = {})
# @option opts [ Object ] :comment A user-provided
# comment to attach to this command.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the feature is not enabled.
#
# See https://mongodb.com/docs/manual/reference/command/listDatabases/
Expand Down
2 changes: 1 addition & 1 deletion lib/mongo/client_encryption.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class ClientEncryption
# to TLS connection options of Mongo::Client.
# @see Mongo::Client#initialize for list of TLS options.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the feature is disabled.
#
# @raise [ ArgumentError ] If required options are missing or incorrectly
Expand Down
42 changes: 21 additions & 21 deletions lib/mongo/collection.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ def ==(other)
# @option options [ Session ] :session The session to use for the operation.
# @option options [ Integer ] :size The size of the capped collection.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the database or the client.
# @option opts [ Hash ] :time_series Create a time-series collection.
Expand Down Expand Up @@ -444,7 +444,7 @@ def create(opts = {})
# @option opts [ Hash | nil ] :encrypted_fields Encrypted fields hash that
# was provided to `create` collection helper.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand Down Expand Up @@ -519,7 +519,7 @@ def drop(opts = {})
# :timeout_ms (whether it applies to the lifetime of the cursor, or per
# iteration).
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
# @option options [ Hash ] :let Mapping of variables to use in the command.
Expand Down Expand Up @@ -556,7 +556,7 @@ def find(filter = nil, options = {})
# milliseconds to allow the aggregation to run.
# @option options [ Session ] :session The session to use.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand Down Expand Up @@ -630,7 +630,7 @@ def aggregate(pipeline, options = {})
# :timeout_ms (whether it applies to the lifetime of the cursor, or per
# iteration).
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand Down Expand Up @@ -665,7 +665,7 @@ def watch(pipeline = [], options = {})
# @option options [ Object ] :comment A user-provided
# comment to attach to this command.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand Down Expand Up @@ -705,7 +705,7 @@ def count(filter = nil, options = {})
# @option options [ Object ] :comment A user-provided
# comment to attach to this command.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand All @@ -730,7 +730,7 @@ def count_documents(filter = {}, options = {})
# @option options [ Object ] :comment A user-provided
# comment to attach to this command.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand All @@ -755,7 +755,7 @@ def estimated_document_count(options = {})
# @option options [ Hash ] :collation The collation to use.
# @option options [ Session ] :session The session to use.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand Down Expand Up @@ -831,7 +831,7 @@ def inspect
# this command.
# @option opts [ Session ] :session The session to use for the operation.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
# @option opts [ Hash ] :write_concern The write concern options.
Expand Down Expand Up @@ -892,7 +892,7 @@ def insert_one(document, opts = {})
# should be executed in order.
# @option options [ Session ] :session The session to use for the operation.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
# @option options [ Hash ] :write_concern The write concern options.
Expand Down Expand Up @@ -924,7 +924,7 @@ def insert_many(documents, options = {})
# not to skip document level validation.
# @option options [ Session ] :session The session to use for the set of operations.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
# @option options [ Hash ] :let Mapping of variables to use in the command.
Expand All @@ -950,7 +950,7 @@ def bulk_write(requests, options = {})
# @option options [ Hash | String ] :hint The index to use for this operation.
# May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
# @option options [ Hash ] :let Mapping of variables to use in the command.
Expand All @@ -976,7 +976,7 @@ def delete_one(filter = nil, options = {})
# @option options [ Hash | String ] :hint The index to use for this operation.
# May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
# @option options [ Hash ] :let Mapping of variables to use in the command.
Expand Down Expand Up @@ -1008,7 +1008,7 @@ def delete_many(filter = nil, options = {})
# :timeout_ms (whether it applies to the lifetime of the cursor, or per
# iteration).
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand All @@ -1035,7 +1035,7 @@ def parallel_scan(cursor_count, options = {})
# @option options [ Hash ] :collation The collation to use.
# @option options [ Session ] :session The session to use.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
# @option options [ Hash | String ] :hint The index to use for this operation.
Expand Down Expand Up @@ -1068,7 +1068,7 @@ def replace_one(filter, replacement, options = {})
# an update should apply.
# @option options [ Session ] :session The session to use.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
# @option options [ Hash | String ] :hint The index to use for this operation.
Expand Down Expand Up @@ -1101,7 +1101,7 @@ def update_many(filter, update, options = {})
# an update should apply.
# @option options [ Session ] :session The session to use.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
# @option options [ Hash | String ] :hint The index to use for this operation.
Expand Down Expand Up @@ -1135,7 +1135,7 @@ def update_one(filter, update, options = {})
# @option options [ Hash ] :collation The collation to use.
# @option options [ Session ] :session The session to use.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
# @option options [ Hash | String ] :hint The index to use for this operation.
Expand Down Expand Up @@ -1183,7 +1183,7 @@ def find_one_and_delete(filter, options = {})
# @option options [ Hash ] :let Mapping of variables to use in the command.
# See the server documentation for details.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand Down Expand Up @@ -1223,7 +1223,7 @@ def find_one_and_update(filter, update, options = {})
# @option options [ Hash | String ] :hint The index to use for this operation.
# May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
# @option options [ Hash ] :let Mapping of variables to use in the command.
Expand Down
2 changes: 1 addition & 1 deletion lib/mongo/collection/view.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ def hash
# :timeout_ms (whether it applies to the lifetime of the cursor, or per
# iteration).
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand Down
2 changes: 1 addition & 1 deletion lib/mongo/collection/view/aggregation.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ class Aggregation
# :timeout_ms (whether it applies to the lifetime of the cursor, or per
# iteration).
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand Down
8 changes: 4 additions & 4 deletions lib/mongo/collection/view/readable.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ module Readable
# milliseconds to allow the aggregation to run.
# @option options [ Session ] :session The session to use.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand Down Expand Up @@ -158,7 +158,7 @@ def comment(comment = nil)
# @option opts [ Object ] :comment A user-provided
# comment to attach to this command.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand Down Expand Up @@ -229,7 +229,7 @@ def count(opts = {})
# @option ops [ Object ] :comment A user-provided
# comment to attach to this command.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand Down Expand Up @@ -264,7 +264,7 @@ def count_documents(opts = {})
# @option opts [ Object ] :comment A user-provided
# comment to attach to this command.
# @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
# Must a non-negative integer. An explicit value of 0 means infinite.
# Must be a non-negative integer. An explicit value of 0 means infinite.
# The default value is unset which means the value is inherited from
# the collection or the database or the client.
#
Expand Down
Loading

0 comments on commit d1bf06e

Please sign in to comment.