[postgis-tickets] r14489 - fix some typos in docs

Daniel Baston dbaston at gmail.com
Mon Dec 14 15:41:01 PST 2015


Author: dbaston
Date: 2015-12-14 15:41:00 -0800 (Mon, 14 Dec 2015)
New Revision: 14489

Modified:
   branches/2.2/doc/reference_processing.xml
Log:
fix some typos in docs

Modified: branches/2.2/doc/reference_processing.xml
===================================================================
--- branches/2.2/doc/reference_processing.xml	2015-12-14 23:40:07 UTC (rev 14488)
+++ branches/2.2/doc/reference_processing.xml	2015-12-14 23:41:00 UTC (rev 14489)
@@ -2774,16 +2774,16 @@
 		<note><para>Note that returned geometry might lose its
 				simplicity (see <xref linkend="ST_IsSimple" />)</para></note>
 		<note><para>Note topology may not be preserved and may result in invalid geometries.  Use  (see <xref linkend="ST_SimplifyPreserveTopology" />) to preserve topology.</para></note>
-		<note><para>This function handles 3D and the third dimmension will affect the result</para></note>
+		<note><para>This function handles 3D and the third dimension will affect the result.</para></note>
 		<para>Availability: 2.2.0</para>
 	  </refsection>
 
 		  <refsection>
 			<title>Examples</title>
-			<para>A linestring that get the efffective area calculated. All points is returned since we give 0 as themin area threashold</para>
+			<para>A LineString is simplified with a minimum area threshold of 30.</para>
 				<programlisting>
 
-select ST_AStext(ST_SimplifyVW(geom,30)) simplified
+select ST_AsText(ST_SimplifyVW(geom,30)) simplified
 FROM (SELECT  'LINESTRING(5 2, 3 8, 6 20, 7 25, 10 10)'::geometry geom) As foo; 
 -result
  simplified
@@ -2800,8 +2800,9 @@
 		<refentry id="ST_SetEffectiveArea">
 	  <refnamediv>
 		<refname>ST_SetEffectiveArea</refname>
-		<refpurpose>Sets for each vertex point it's effective area,  
-			and can by filtring  on this area return a simplified geometry</refpurpose>
+		<refpurpose>
+			Sets the effective area for each vertex, storing the value in the M ordinate.  A simplified geometry can then be generated by filtering on the M ordinate.
+		</refpurpose>
 	  </refnamediv>
 
 	  <refsynopsisdiv>
@@ -2809,7 +2810,7 @@
 		  <funcprototype>
 			<funcdef>geometry <function>ST_SetEffectiveArea</function></funcdef>
 			<paramdef><type>geometry</type> <parameter>geomA</parameter></paramdef>
-			<paramdef><type>float</type> <parameter>threashold = 0</parameter></paramdef>
+			<paramdef><type>float</type> <parameter>threshold = 0</parameter></paramdef>
 			<paramdef><type>integer</type> <parameter>set_area = 1</parameter></paramdef>
 		  </funcprototype>
 		</funcsynopsis>
@@ -2817,13 +2818,14 @@
 
 	  <refsection>
 		<title>Description</title>
-		<para> Sets for each vertex point it's effective area from Visvalingam-Whyatt’s algorithm.
-			The effective area is stored as the M-value of the geomtries. 
-			If the second optional parameter is used, the resulting geometriy will be build only on vertex points with an effective area 
-			greater than or equal to that threashold value. That will be a simplified geometry.
+		<para>
+			Sets the effective area for each vertex, using the Visvalingam-Whyatt algorithm.
+			The effective area is stored as the M-value of the vertex. 
+			If the optional "theshold" parameter is used, a simplified geometry will be returned, containing only vertices with an effective area 
+            greater than or equal to the threshold value.
 			</para><para>
-			This function can be used for server side simplification by using the threashold. Another option is to not give any threashold value. 
-			Then you get the full geometry back, but with effective areas as M-values wich can be used by the client to simplify very fast.
+			This function can be used for server-side simplification when a threshold is specified.  Another option is to use a threshold value of zero.
+			In this case, the full geometry will be returned with effective areas as M-values, which can be used by the client to simplify very quickly.
 			</para><para>
 			Will actually do something only with
 			(multi)lines and (multi)polygons but you can safely call it with
@@ -2837,16 +2839,18 @@
 				simplicity (see <xref linkend="ST_IsSimple" />)</para></note>
 		<note><para>Note topology may not be preserved and may result in invalid geometries.  Use  (see <xref linkend="ST_SimplifyPreserveTopology" />) to preserve topology.</para></note>
 		<note><para>The output geometry will lose all previous information in the M-values</para></note>
-		<note><para>This function handles 3D and the third dimmension will affect the effective area</para></note>
+		<note><para>This function handles 3D and the third dimension will affect the effective area</para></note>
 		<para>Availability: 2.2.0</para>
 	  </refsection>
 
 		  <refsection>
 			<title>Examples</title>
-			<para>A linestring that get the efffective area calculated. All points is returned since we give 0 as themin area threashold</para>
+			<para>
+				Calculating the effective area of a LineString.  Because we use a threshold value of zero, all vertices in the input geometry are returned.
+			</para>
 				<programlisting>
 
-select ST_AStext(ST_SetEffectiveArea(geom)) all_pts, ST_AStext(ST_SetEffectiveArea(geom,30) ) thrshld_30
+select ST_AsText(ST_SetEffectiveArea(geom)) all_pts, ST_AsText(ST_SetEffectiveArea(geom,30) ) thrshld_30
 FROM (SELECT  'LINESTRING(5 2, 3 8, 6 20, 7 25, 10 10)'::geometry geom) As foo; 
 -result
  all_pts | thrshld_30



More information about the postgis-tickets mailing list