From f4ddb4da89906e2339eefcb835e2af4673218b30 Mon Sep 17 00:00:00 2001
From: Steve Schwartz <steve@alfajango.com>
Date: Thu, 10 Feb 2011 17:28:53 -0500
Subject: Added RDoc info for accepted options for simple_format in TextHelper.

---
 actionpack/lib/action_view/helpers/text_helper.rb | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'actionpack/lib/action_view')

diff --git a/actionpack/lib/action_view/helpers/text_helper.rb b/actionpack/lib/action_view/helpers/text_helper.rb
index 4f7f5c454f..2d3c5fe7e7 100644
--- a/actionpack/lib/action_view/helpers/text_helper.rb
+++ b/actionpack/lib/action_view/helpers/text_helper.rb
@@ -234,6 +234,10 @@ module ActionView
       #
       # 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 @@ module ActionView
       #
       #   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)
-- 
cgit v1.2.3