From: Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
Date: Fri, 14 Sep 2007 21:56:15 +0000 (+0000)
Subject: httputil: document 'headers' option to get_* methods
X-Git-Url: https://git.netwichtig.de/gitweb/?a=commitdiff_plain;h=5d27f65e540393ddcf00faed2bf514fe5c6630d8;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git

httputil: document 'headers' option to get_* methods
---

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)