public
Description: PLEASE CHECK http://github.com/lifo/docrails/wikis
Homepage: http://weblog.rubyonrails.org/2008/5/2/help-improve-rails-documentation-on-git-branch
Clone URL: git://github.com/lifo/docrails.git
Improve documentation for ActionController::Session.get.
Hongli Lai (Phusion) (author)
Fri Jul 18 11:47:45 -0700 2008
commit  632a4705b9d492bf3c9c2973b12330ad73e6f420
tree    93ee24abf88da628d150ac2f91b753027cf26fcd
parent  b32a24abc993c44af6123375b15681f141d95891
...
165
166
167
168
169
170
171
172
 
 
 
 
 
 
 
 
 
 
 
 
 
173
174
175
...
165
166
167
 
 
 
 
 
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
0
@@ -165,11 +165,19 @@ module ActionController
0
         status/100 == 3
0
       end
0
 
0
-      # Performs a GET request with the given parameters. The parameters may
0
-      # be +nil+, a Hash, or a string that is appropriately encoded
0
-      # (<tt>application/x-www-form-urlencoded</tt> or <tt>multipart/form-data</tt>).
0
-      # The headers should be a hash. The keys will automatically be upcased, with the
0
-      # prefix 'HTTP_' added if needed.
0
+      # Performs a GET request with the given parameters.
0
+      #
0
+      # - +path+: The URI (as a String) on which you want to perform a GET request.
0
+      # - +parameters+: The HTTP parameters that you want to pass. This may be +nil+,
0
+      #   a Hash, or a String that is appropriately encoded
0
+      #   (<tt>application/x-www-form-urlencoded</tt> or <tt>multipart/form-data</tt>).
0
+      # - +headers+: Additional HTTP headers to pass, as a Hash. The keys will
0
+      #   automatically be upcased, with the prefix 'HTTP_' added if needed.
0
+      #
0
+      # This method returns an AbstractResponse object, which one can use to inspect
0
+      # the details of the response. Furthermore, if this method was called from an
0
+      # ActionController::IntegrationTest object, then that object's +@response+ instance
0
+      # variable will point to the same response object.
0
       #
0
       # You can also perform POST, PUT, DELETE, and HEAD requests with +post+,
0
       # +put+, +delete+, and +head+.

Comments