Permalink
Browse files

Added RDoc info for accepted options for simple_format in TextHelper.

  • Loading branch information...
1 parent 35a266e commit f4ddb4da89906e2339eefcb835e2af4673218b30 @JangoSteve JangoSteve committed Feb 10, 2011
Showing with 7 additions and 0 deletions.
  1. +7 −0 actionpack/lib/action_view/helpers/text_helper.rb
@@ -234,6 +234,10 @@ def word_wrap(text, *args)
#
# You can pass any HTML attributes into <tt>html_options</tt>. These
# will be added to all created paragraphs.
+ #
+ # ==== Options
+ # * <tt>:sanitize</tt> - If +false+, does not sanitize +text+.
+ #
# ==== Examples
# my_text = "Here is some basic text...\n...with a line break."
#
@@ -247,6 +251,9 @@ def word_wrap(text, *args)
#
# simple_format("Look ma! A class!", :class => 'description')
# # => "<p class='description'>Look ma! A class!</p>"
+ #
+ # simple_format("<span>I'm allowed!</span> It's true.", {}, :sanitize => false)
+ # # => "<p><span>I'm allowed!</span> It's true.</p>"
def simple_format(text, html_options={}, options={})
text = ''.html_safe if text.nil?
start_tag = tag('p', html_options, true)

0 comments on commit f4ddb4d

Please sign in to comment.