Add documentation to assert_tag indicating that it only works with well-formed XHTML

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@2894 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

actionpack/CHANGELOG

@@ -1,5 +1,7 @@
 *SVN*
 
+* Add documentation to assert_tag indicating that it only works with well-formed XHTML #1937, #2570 [Jamis Buck]
+
 * Added action_pack.rb stub so that ActionPack::Version loads properly [Sam Stephenson]
 
 * Added short-hand to assert_tag so assert_tag :tag => "span" can be written as assert_tag "span" [DHH]

actionpack/lib/action_controller/assertions.rb

@@ -257,6 +257,12 @@ module Test #:nodoc:
       #                           :attributes => { :class => "enum" } },
       #              :descendant => { :tag => "span",
       #                               :child => /hello world/ }
+      #
+      # <strong>Please note</strong: #assert_tag and #assert_no_tag only work
+      # with well-formed XHTML. They recognize a few tags as implicitly self-closing
+      # (like br and hr and such) but will not work correctly with tags
+      # that allow optional closing tags (p, li, td). <em>You must explicitly
+      # close all of your tags to use these assertions.</em>
       def assert_tag(*opts)
         clean_backtrace do
           opts = opts.size > 1 ? opts.last.merge({ :tag => opts.first.to_s }) : opts.first