[CLIENT] Improve client documentation for compression option

estolfo · estolfo · commit c248155ea687 · 2019-06-25T11:53:20.000+02:00
diff --git a/elasticsearch-transport/lib/elasticsearch/transport/client.rb b/elasticsearch-transport/lib/elasticsearch/transport/client.rb
@@ -108,8 +108,9 @@ 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.
+      # @option arguments [true, false] :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.
       #
       # @yield [faraday] Access and configure the `Faraday::Connection` instance directly with a block
       #

Original file line number	Diff line number	Diff line change
`@@ -108,8 +108,9 @@ 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`	`+ # @option arguments [true, false] :compression Whether to compress requests. Gzip compression will be used.`
	`112`	`+ # The default is false. Responses will automatically be inflated if they are compressed.`
	`113`	`+ # If a custom transport object is used, it must handle the request compression and response inflation.`
`113`	`114`	`#`
`114`	`115`	# @yield [faraday] Access and configure the `Faraday::Connection` instance directly with a block
`115`	`116`	`#`