[CLIENT] Add documentation of 'compression' option on client

estolfo · estolfo · commit ebe6e42c0f45 · 2019-06-25T11:53:17.000+02:00
diff --git a/elasticsearch-transport/lib/elasticsearch/transport/client.rb b/elasticsearch-transport/lib/elasticsearch/transport/client.rb
@@ -108,6 +108,8 @@ 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. Responses will automatically be
+      #   inflated if they are compressed. Gzip compression will be used. The default is false.
       #
       # @yield [faraday] Access and configure the `Faraday::Connection` instance directly with a block
       #

Original file line number	Diff line number	Diff line change
`@@ -108,6 +108,8 @@ class Client`
`108`	`108`	`#`
`109`	`109`	`# @option arguments [String] :send_get_body_as Specify the HTTP method to use for GET requests with a body.`
`110`	`110`	`# (Default: GET)`
	`111`	`+ # @option arguments [true, false] :compression Whether to compress requests. Responses will automatically be`
	`112`	`+ # inflated if they are compressed. Gzip compression will be used. The default is false.`
`111`	`113`	`#`
`112`	`114`	# @yield [faraday] Access and configure the `Faraday::Connection` instance directly with a block
`113`	`115`	`#`