aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib
diff options
context:
space:
mode:
authorGuillermo Iguaran <guilleiguaran@gmail.com>2015-03-06 15:49:37 -0500
committerGuillermo Iguaran <guilleiguaran@gmail.com>2015-03-06 15:49:37 -0500
commit809527b282051691d00cee6a44c8e87c5b2adec5 (patch)
tree66bb3689b31db273707e3b49d48acb879ebbe7aa /actionpack/lib
parent959fd6a8e7ac02156a4b5036640ec352fccb0346 (diff)
parente049319c778e638e090309e93daee3d2fe087b15 (diff)
downloadrails-809527b282051691d00cee6a44c8e87c5b2adec5.tar.gz
rails-809527b282051691d00cee6a44c8e87c5b2adec5.tar.bz2
rails-809527b282051691d00cee6a44c8e87c5b2adec5.zip
Merge pull request #19231 from prathamesh-sonpatki/fix-url-for-documentation
Fix documentation of url_for module [ci skip]
Diffstat (limited to 'actionpack/lib')
-rw-r--r--actionpack/lib/action_controller/metal/url_for.rb5
1 files changed, 4 insertions, 1 deletions
diff --git a/actionpack/lib/action_controller/metal/url_for.rb b/actionpack/lib/action_controller/metal/url_for.rb
index 572d1770f7..fbaa90d521 100644
--- a/actionpack/lib/action_controller/metal/url_for.rb
+++ b/actionpack/lib/action_controller/metal/url_for.rb
@@ -4,7 +4,10 @@ module ActionController
#
# In addition to <tt>AbstractController::UrlFor</tt>, this module accesses the HTTP layer to define
# url options like the +host+. In order to do so, this module requires the host class
- # to implement +env+ and +request+, which need to be a Rack-compatible.
+ # to implement +env+ which needs to be Rack-compatible and +request+
+ # which is either instance of +ActionDispatch::Request+ or an object
+ # that responds to <tt>host</tt>, <tt>optional_port</tt>, <tt>protocol</tt> and
+ # <tt>symbolized_path_parameter</tt> methods.
#
# class RootUrl
# include ActionController::UrlFor