From f4933963d4d19451a04192a54d0b2f560ae7afc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciek=20Rz=C4=85sa?= Date: Fri, 21 Jun 2024 10:36:37 +0200 Subject: [PATCH] Specify timeout unit and default --- lib/elastic/transport/client.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/elastic/transport/client.rb b/lib/elastic/transport/client.rb index 619cd0d..df52afd 100644 --- a/lib/elastic/transport/client.rb +++ b/lib/elastic/transport/client.rb @@ -91,7 +91,8 @@ class Client # # @option arguments [Boolean] :reload_on_failure Reload connections after failure (false by default) # - # @option arguments [Integer] :request_timeout The request timeout to be passed to transport in options + # @option arguments [Integer] :request_timeout The request timeout to be passed to transport in options in seconds + # (the default value is taken from the transport) # # @option arguments [Symbol] :adapter A specific adapter for Faraday (e.g. `:patron`) # @@ -110,7 +111,7 @@ class Client # # @option arguments [String] :send_get_body_as Specify the HTTP method to use for GET requests with a body. # (Default: GET) - # @option arguments [true, false] :compression Whether to compress requests. Gzip compression will be used. + # @option arguments [Boolean] :compression Whether to compress requests. Gzip compression will be used. # The default is false. Responses will automatically be inflated if they are compressed. # If a custom transport object is used, it must handle the request compression and response inflation. #