From ede5e9b3db8e4238009b582f5ff53029d04d0418 Mon Sep 17 00:00:00 2001
From: Avi Tzurel <avi@kensodev.com>
Date: Sat, 19 May 2012 00:39:31 +0300
Subject: Added wrapper tag documentation to the simple_format method

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

(limited to 'actionpack/lib')

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."
       #
-- 
cgit v1.2.3