Skip to content

Commit

Permalink
Fixes default timeout documentation comment (#317)
Browse files Browse the repository at this point in the history
Motivation:
Right now documentation states that timrout defaults to no timeout, this
is no actually true, if timeout is not set NIO bootstrap defaults to 10
seconds connect timeout.

Modifications:
Updates documentation comment.

Result:
Closes #118
  • Loading branch information
artemredkin authored Nov 11, 2020
1 parent 236b1de commit 0a8dddb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Sources/AsyncHTTPClient/HTTPClient.swift
Original file line number Diff line number Diff line change
Expand Up @@ -639,7 +639,7 @@ public class HTTPClient {
/// - `307: Temporary Redirect`
/// - `308: Permanent Redirect`
public var redirectConfiguration: RedirectConfiguration
/// Default client timeout, defaults to no timeouts.
/// Default client timeout, defaults to no `read` timeout and 10 seconds `connect` timeout.
public var timeout: Timeout
/// Connection pool configuration.
public var connectionPool: ConnectionPool
Expand Down

0 comments on commit 0a8dddb

Please sign in to comment.