diff options
| author | Hongli Lai (Phusion) <hongli@phusion.nl> | 2008-07-18 20:47:45 +0200 |
|---|---|---|
| committer | Hongli Lai (Phusion) <hongli@phusion.nl> | 2008-07-18 20:47:45 +0200 |
| commit | 632a4705b9d492bf3c9c2973b12330ad73e6f420 (patch) | |
| tree | 93ee24abf88da628d150ac2f91b753027cf26fcd | |
| parent | b32a24abc993c44af6123375b15681f141d95891 (diff) | |
| download | rails-632a4705b9d492bf3c9c2973b12330ad73e6f420.tar.gz rails-632a4705b9d492bf3c9c2973b12330ad73e6f420.tar.bz2 rails-632a4705b9d492bf3c9c2973b12330ad73e6f420.zip | |
Improve documentation for ActionController::Session.get.
| -rw-r--r-- | actionpack/lib/action_controller/integration.rb | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/actionpack/lib/action_controller/integration.rb b/actionpack/lib/action_controller/integration.rb index 2a732448f2..66552e1771 100644 --- a/actionpack/lib/action_controller/integration.rb +++ b/actionpack/lib/action_controller/integration.rb @@ -165,11 +165,19 @@ module ActionController status/100 == 3 end - # Performs a GET request with the given parameters. The parameters may - # be +nil+, a Hash, or a string that is appropriately encoded - # (<tt>application/x-www-form-urlencoded</tt> or <tt>multipart/form-data</tt>). - # The headers should be a hash. The keys will automatically be upcased, with the - # prefix 'HTTP_' added if needed. + # Performs a GET request with the given parameters. + # + # - +path+: The URI (as a String) on which you want to perform a GET request. + # - +parameters+: The HTTP parameters that you want to pass. This may be +nil+, + # a Hash, or a String that is appropriately encoded + # (<tt>application/x-www-form-urlencoded</tt> or <tt>multipart/form-data</tt>). + # - +headers+: Additional HTTP headers to pass, as a Hash. The keys will + # automatically be upcased, with the prefix 'HTTP_' added if needed. + # + # This method returns an AbstractResponse object, which one can use to inspect + # the details of the response. Furthermore, if this method was called from an + # ActionController::IntegrationTest object, then that object's +@response+ instance + # variable will point to the same response object. # # You can also perform POST, PUT, DELETE, and HEAD requests with +post+, # +put+, +delete+, and +head+. |