summary refs log tree commit
diff options
context:
space:
mode:
authorRafael Mendonça França <rafaelmfranca@gmail.com>2017-07-24 20:51:22 -0400
committerRafael Mendonça França <rafaelmfranca@gmail.com>2017-07-24 20:51:22 -0400
commit9899d3ad3ccb9365186d969141a606eae015dd9f (patch)
tree34a4b4134b56f0fb8ec370cb9829856c3c110421
parentb76ca575c5dfc08366c26f7cb577fdc14d879f8a (diff)
downloadrack-9899d3ad3ccb9365186d969141a606eae015dd9f.tar.gz
Improve documentation about the sync option on deflater
-rw-r--r--lib/rack/deflater.rb5
1 files changed, 3 insertions, 2 deletions
diff --git a/lib/rack/deflater.rb b/lib/rack/deflater.rb
index 0d0d021f..abea9dec 100644
--- a/lib/rack/deflater.rb
+++ b/lib/rack/deflater.rb
@@ -24,9 +24,10 @@ module Rack
     #           'if' - a lambda enabling / disabling deflation based on returned boolean value
     #                  e.g use Rack::Deflater, :if => lambda { |env, status, headers, body| body.map(&:bytesize).reduce(0, :+) > 512 }
     #           'include' - a list of content types that should be compressed
-    #           'sync' - Flushing after every chunk reduces latency for
+    #           'sync' - determines if the stream is going to be flused after every chunk.
+    #                    Flushing after every chunk reduces latency for
     #                    time-sensitive streaming applications, but hurts
-    #                    compression and throughput.  Defaults to `true'.
+    #                    compression and throughput. Defaults to `true'.
     def initialize(app, options = {})
       @app = app