[postgis-tickets] r14714 - Put in availability info in docs for ST_ClusterKMeans, ST_ClusterDBSCAN

[Regina Obe]

Author: robe
Date: 2016-02-27 06:53:40 -0800 (Sat, 27 Feb 2016)
New Revision: 14714

Modified:
   trunk/doc/reference_measure.xml
Log:
Put in availability info in docs for ST_ClusterKMeans, ST_ClusterDBSCAN
Closes #3478

Modified: trunk/doc/reference_measure.xml
===================================================================
--- trunk/doc/reference_measure.xml	2016-02-27 09:21:31 UTC (rev 14713)
+++ trunk/doc/reference_measure.xml	2016-02-27 14:53:40 UTC (rev 14714)
@@ -1054,7 +1054,7 @@
 	  <refnamediv>
 		<refname>ST_ClusterDBSCAN</refname>
 
-        <refpurpose>Windowing function that returns integer id for the cluster each input geometry is in.</refpurpose>
+        <refpurpose>Windowing function that returns integer id for the cluster each input geometry is in based on 2D implementation of Density-based spatial clustering of applications with noise (DBSCAN) algorithm.</refpurpose>
     </refnamediv>
 
 	  <refsynopsisdiv>
@@ -1079,11 +1079,13 @@
 
       <para>Returns cluster number for each input geometry, based on a 2D 
           implementation of the 
-          <ulink url="https://en.wikipedia.org/wiki/DBSCAN">DBSCAN</ulink> 
+          <ulink url="https://en.wikipedia.org/wiki/DBSCAN">Density-based spatial clustering of applications with noise (DBSCAN)</ulink> 
           algorithm.  An input geometry will be added to a cluster if it is 
           within <varname>eps</varname> distance of at least
-          <varname>minpoints</varname> other input geometries.
+          <varname>minpoints</varname> other input geometries.  Unlike <xref linked="ST_ClusterKMeans" />, it does not require to specify the number of
+          clusters for each dataset, but instead uses the desired input distance <varname>eps</varname> at optimal cluster size for each cluster.
       </para>
+      <para>Availability: 2.3.0 - requires GEOS </para>
     </refsection>
 
     <refsection>
@@ -1098,7 +1100,7 @@
 
 
         <para>
-            Combining parcels with the same cluster number into a single geometry:
+            Combining parcels with the same cluster number into a single geometry. This uses named argument calling
         </para>
 		    <programlisting>
 SELECT cid, ST_Collect(geom) AS cluster_geom, array_agg(parcel_id) AS ids_in_cluster FROM (
@@ -1204,6 +1206,7 @@
         cluster number for each input geometry. The distance used for clustering is the 
         distance between the centroids of the geometries.
       </para>
+      <para>Availability: 2.3.0 - requires GEOS </para>
     </refsection>
 
     <refsection>