diff options
author | Prathamesh Sonpatki <csonpatki@gmail.com> | 2015-03-06 17:18:46 +0530 |
---|---|---|
committer | Prathamesh Sonpatki <csonpatki@gmail.com> | 2015-03-06 19:51:07 +0530 |
commit | e049319c778e638e090309e93daee3d2fe087b15 (patch) | |
tree | f80cd6557b8a816ba4926dfb6ed27b2c6ae39ca2 /actionpack | |
parent | eac3349285718e2a145c1e85e1fdb7bf96fc5bd1 (diff) | |
download | rails-e049319c778e638e090309e93daee3d2fe087b15.tar.gz rails-e049319c778e638e090309e93daee3d2fe087b15.tar.bz2 rails-e049319c778e638e090309e93daee3d2fe087b15.zip |
Fix documentation of url_for module [ci skip]
- The request needs to be instance of ActionDispatch::Request or an
object that responds to host, optional_port, protocol and
symbolized_path_parameter.
- This documentation was correctly added in
https://github.com/rails/rails/commit/e3b3f416b57f5642ea25078485f7e9394ad04526
but was changed to
https://github.com/rails/rails/commit/e1ceae576e3911f3e6708b5d19a0e3ef63769eb7.
- Fixes #16160.
Diffstat (limited to 'actionpack')
-rw-r--r-- | actionpack/lib/action_controller/metal/url_for.rb | 5 |
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 |