url_for documentation - only_path

url_for behaves differently depending on whether it is called from within a view or within a controller.

From within a view, the default is a relative URL, and :only_path => false gives you the full URL.

From within a controller, the default is a full URL, and :only_path => true gives you the relative URL.

Sample code with a scaffold 'Person'

Controller:
@@@ruby def show

@person = Person.find(params[:id])

@person_url = url_for(@person)
@person_url_only_path_false = url_for(:id => params[:id], :only_path => false)
@person_url_only_path_true = url_for(:id => params[:id], :only_path => true)

end

show.rhtml
@@@ruby
<p>IN THE VIEW</p>
<p>url_for(@person) = <%= url_for(@person) %></p>
<p>url_for(:id => 1, :only_path => false) = <%= url_for(:id => 1, :only_path => false) %></p>
<p>url_for(:id => 1, :only_path => true) = <%= url_for(:id => 1, :only_path => true) %></p>







<p>FROM THE CONTROLLER</p>
<p>url_for(@person) = <%= @person_url %></p>
<p>url_for(:id => 1, :only_path => false) = <%= @person_url_only_path_false %></p>
<p>url_for(:id => 1, :only_path => true) = <%= @person_url_only_path_true %></p>

The documentation is correct.

IMHO, it would read better if the option were named :full_url, :full_path, or :fully_qualified.

It's always clearer if the option is stated as a positive, so the default can be false. (For that matter, why isn't there a path_for method like with the other url helper methods?)