summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorGiuseppe Bilotta <giuseppe.bilotta@gmail.com>2007-09-14 21:56:15 +0000
committerGiuseppe Bilotta <giuseppe.bilotta@gmail.com>2007-09-14 21:56:15 +0000
commit5d27f65e540393ddcf00faed2bf514fe5c6630d8 (patch)
tree70f430402189efba516ed5b380df35d8bbd96bcb /lib
parent1251ec6da4b3371c2294470f5441157c6ba0a3d0 (diff)
httputil: document 'headers' option to get_* methods
Diffstat (limited to 'lib')
-rw-r--r--lib/rbot/core/utils/httputil.rb2
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/rbot/core/utils/httputil.rb b/lib/rbot/core/utils/httputil.rb
index 3a267da1..0bc579b1 100644
--- a/lib/rbot/core/utils/httputil.rb
+++ b/lib/rbot/core/utils/httputil.rb
@@ -433,6 +433,8 @@ class HttpUtil
# range:: make a ranged request (usually GET). accepts a string
# for HTTP/1.1 "Range:" header (i.e. "bytes=0-1000")
# body:: request body (usually for POST requests)
+ # headers:: additional headers to be set for the request. Its value must
+ # be a Hash in the form { 'Header' => 'value' }
#
def get_response(uri_or_s, options = {}, &block) # :yields: resp
uri = uri_or_s.kind_of?(URI) ? uri_or_s : URI.parse(uri_or_s.to_s)