Put in disclaimer on ST_Equals when dealing with invalid geometries

git-svn-id: http://svn.osgeo.org/postgis/trunk@2938 b70326c6-7e19-0410-871a-916f4a2858ee

diff --git a/doc/reference_new.xml b/doc/reference_new.xml
index ea9d73c535b9ee630faa1e1043de6081336d0ce5..3e0c4f70dd59baf8fb3368d3b97d15d2876990a8 100644 (file)
--- a/doc/reference_new.xml
+++ b/doc/reference_new.xml
@@ -3787,6 +3787,10 @@ SELECT s.gid, s.school_name
                        represent the same geometry structure.  To verify the order of points is consistent, use 
                        ST_OrderingEquals (it must be noted ST_OrderingEquals is a little more stringent than simply verifying order of
                        points are the same).</para>
+                       
+               <note>
+                 <para>This function will return false if either geometry is invalid even if they are binary equal.</para>
+               </note>
 
                <para>
                  <inlinegraphic class="sfs_compliant" fileref="images/check.png" />
@@ -3827,7 +3831,7 @@ SELECT ST_Equals(ST_Reverse(ST_GeomFromText('LINESTRING(0 0, 10 10)')),
          <refsection>
                <title>See Also</title>
        
-               <para><xref linkend="ST_OrderingEquals"/>, <xref linkend="ST_Reverse"/>, <xref linkend="ST_Within" /></para>
+               <para><xref linkend="ST_IsValid"/>, <xref linkend="ST_OrderingEquals"/>, <xref linkend="ST_Reverse"/>, <xref linkend="ST_Within" /></para>
          </refsection>
          
        </refentry>