summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSamuel Williams <samuel.williams@oriontransfer.co.nz>2020-01-24 12:05:53 +1300
committerSamuel Williams <samuel.williams@oriontransfer.co.nz>2020-01-24 12:08:16 +1300
commitc66fcd6acc01383ffbb5af277d7caafe32d66928 (patch)
tree1e05e9fc8757771e8bd11cbbd556a0b45254c36e
parent905a83dc10c40c3fae0199918190d09f1302aba4 (diff)
downloadrack-c66fcd6acc01383ffbb5af277d7caafe32d66928.tar.gz
Fix documentation type syntax.
-rw-r--r--lib/rack/response.rb5
1 files changed, 3 insertions, 2 deletions
diff --git a/lib/rack/response.rb b/lib/rack/response.rb
index a7bece8d..fb9d734b 100644
--- a/lib/rack/response.rb
+++ b/lib/rack/response.rb
@@ -30,7 +30,7 @@ module Rack
# Initialize the response object with the specified body, status
# and headers.
#
- # @param body [nil | #each | #to_str] the response body.
+ # @param body [nil, #each, #to_str] the response body.
# @param status [Integer] the integer status as defined by the
# HTTP protocol RFCs.
# @param headers [#each] a list of key-value header pairs which
@@ -76,8 +76,9 @@ module Rack
CHUNKED == get_header(TRANSFER_ENCODING)
end
+ # Generate a response array consistent with the requirements of the SPEC.
# @return [Array] a 3-tuple suitable of `[status, headers, body]`
- # which is a suitable response from the middleware `#call(env)` method.
+ # which is suitable to be returned from the middleware `#call(env)` method.
def finish(&block)
if STATUS_WITH_NO_ENTITY_BODY[status.to_i]
delete_header CONTENT_TYPE