aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib
diff options
context:
space:
mode:
authorAvi Tzurel <avi@kensodev.com>2012-05-19 00:39:31 +0300
committerAvi Tzurel <avi@kensodev.com>2012-05-19 00:39:31 +0300
commitede5e9b3db8e4238009b582f5ff53029d04d0418 (patch)
tree5d4261ae432edb09538c329ae8b79b4d3fd17c6d /actionpack/lib
parent21bff1d66477f5cf27bc7ada675866d810116d23 (diff)
downloadrails-ede5e9b3db8e4238009b582f5ff53029d04d0418.tar.gz
rails-ede5e9b3db8e4238009b582f5ff53029d04d0418.tar.bz2
rails-ede5e9b3db8e4238009b582f5ff53029d04d0418.zip
Added wrapper tag documentation to the simple_format method
Diffstat (limited to 'actionpack/lib')
-rw-r--r--actionpack/lib/action_view/helpers/text_helper.rb5
1 files changed, 4 insertions, 1 deletions
diff --git a/actionpack/lib/action_view/helpers/text_helper.rb b/actionpack/lib/action_view/helpers/text_helper.rb
index 67117077dc..db146d4a68 100644
--- a/actionpack/lib/action_view/helpers/text_helper.rb
+++ b/actionpack/lib/action_view/helpers/text_helper.rb
@@ -235,13 +235,16 @@ module ActionView
#
# ==== Options
# * <tt>:sanitize</tt> - If +false+, does not sanitize +text+.
- # * <tt>:wrapper_tag</tt> - String representing the tag wrapper, defaults to <tt>"p"</tt>
+ # * <tt>:wrapper_tag</tt> - String representing the wrapper tag, defaults to <tt>"p"</tt>
#
# ==== Examples
# my_text = "Here is some basic text...\n...with a line break."
#
# simple_format(my_text)
# # => "<p>Here is some basic text...\n<br />...with a line break.</p>"
+ #
+ # simple_format(my_text, :wrapper_tag => "div")
+ # # => "<div>Here is some basic text...\n<br />...with a line break.</div>"
#
# more_text = "We want to put a paragraph...\n\n...right there."
#