Fix documentation of GetRingEdges

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

diff --git a/doc/extras_topology.xml b/doc/extras_topology.xml
index 2778675eb65575d4cf94e9e76cbbe6a6716a659b..e747ccd2db8b9e6e9b1e800a56afda11b8609202 100644 (file)
--- a/doc/extras_topology.xml
+++ b/doc/extras_topology.xml
@@ -1836,6 +1836,7 @@ Returns an ordered set of edges forming a ring with the given edge .
                                        <funcdef>getfaceedges_returntype <function>GetRingEdges</function></funcdef>
                                        <paramdef><type>varchar </type> <parameter>atopology</parameter></paramdef>
                                        <paramdef><type>integer </type> <parameter>aring</parameter></paramdef>
+                                       <paramdef choice="opt"><type>integer </type> <parameter>max_edges=null</parameter></paramdef>
                                        </funcprototype>
                                </funcsynopsis>
                        </refsynopsisdiv>
@@ -1851,6 +1852,12 @@ A negative edge identifier means that the given edge is taken backward.
 You can pass a negative edge id to start walking backward.
                </para>
 
+                <para>
+If <varname>max_edges</varname> is not null no more than those records
+are returned by that function. This is meant to be a safety parameter
+when dealing with possibly invalid topologies.
+               </para>
+
                 
                 <!-- use this format if new function -->
                 <para>Availability: 2.0 </para>