[postgis-commits] svn - r2938 - trunk/doc

[postgis-commits at postgis.refractions.net]

Author: robe
Date: 2008-09-04 11:28:31 -0700 (Thu, 04 Sep 2008)
New Revision: 2938

Modified:
   trunk/doc/reference_new.xml
Log:
Put in disclaimer on ST_Equals when dealing with invalid geometries

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2008-09-04 12:40:51 UTC (rev 2937)
+++ trunk/doc/reference_new.xml	2008-09-04 18:28:31 UTC (rev 2938)
@@ -3787,6 +3787,10 @@
 			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 @@
 	  <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>