Permalink
Browse files

RDoc tweaks

  • Loading branch information...
1 parent 1fd6633 commit 1571c9e0bedc9d1a74fbddb357668bb6dd5b20c7 @fxn fxn committed Aug 7, 2013
Showing with 10 additions and 5 deletions.
  1. +10 −5 actionpack/lib/action_view/helpers/form_options_helper.rb
@@ -97,14 +97,17 @@ module FormOptionsHelper
# Create a select tag and a series of contained option tags for the provided object and method.
# The option currently held by the object will be selected, provided that the object is available.
#
- # There are two possible formats for the choices parameter, corresponding to other helpers' output:
- # * A flat collection: see options_for_select
- # * A nested collection: see grouped_options_for_select
+ # There are two possible formats for the +choices+ parameter, corresponding to other helpers' output:
+ #
+ # * A flat collection (see +options_for_select+).
+ #
+ # * A nested collection (see +grouped_options_for_select+).
+ #
+ # For example:
#
- # Example with @post.person_id => 1:
# select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, { include_blank: true })
#
- # could become:
+ # would become:
#
# <select name="post[person_id]">
# <option value=""></option>
@@ -113,6 +116,8 @@ module FormOptionsHelper
# <option value="3">Tobias</option>
# </select>
#
+ # assuming the associated person has ID 1.
+ #
# This can be used to provide a default set of options in the standard way: before rendering the create form, a
# new model instance is assigned the default options and bound to @model_name. Usually this model is not saved
# to the database. Instead, a second model object is created when the create request is received.

0 comments on commit 1571c9e

Please sign in to comment.