Skip to content

Commit 324bf90

Browse files
committed
update the documentation
1 parent 6847dbd commit 324bf90

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -490,8 +490,8 @@ you'll want to add this cipher to your `ssl_opts`:
490490
491491
## Timeout
492492
493-
The `:timeout` option is only used to specify the timeout for receiving data on the tcp layer. The default value is 15 seconds.
494-
The connection pool defines separate timeout values.
493+
The `:timeout` option sets the maximum time that the caller is allowed to hold the connection’s state (to send and to receive data).
494+
The default value is 15 seconds. The connection pool defines additional timeout values.
495495
You can use the `:timeout` as a global option to override the default value:
496496
497497
```elixir
@@ -506,7 +506,7 @@ using the `:timeout` option, when running a single command:
506506
Mongo.find(conn, "dogs", %{}, timeout: 120_000)
507507
```
508508
509-
Now the driver will use 120 seconds for the timeout.
509+
Now the driver will use 120 seconds as the timeout for the single query.
510510
511511
## Change Streams
512512

0 commit comments

Comments
 (0)