From: Regina Obe <lr@pcorp.us>
Date: Sat, 3 Oct 2015 16:20:44 +0000 (+0000)
Subject: #1748: change arg names in raster ST_Intersection docs to agree with arg names instal... 
X-Git-Tag: 2.2.0~33
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a5f37f8b5920fe30079a293373af83d66b1f1975;p=postgis

#1748: change arg names in raster ST_Intersection docs to agree with arg names installed.  Also get rid of coming soon raster/geom that returns raster -- that's called ST_Clip.  Put in a note about that for people looking at ST_Intersection wanting ST_Clip.  Get rid of default args that aren't default at all (we have more protos than we need - may want to consider removing them in 2.3 and replacing with default args)

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

diff --git a/doc/reference_raster.xml b/doc/reference_raster.xml
index ddad72c5c..0c5fd340c 100644
--- a/doc/reference_raster.xml
+++ b/doc/reference_raster.xml
@@ -8973,8 +8973,8 @@ FROM funky_shapes;
 					  <funcprototype>
 							<funcdef>setof geomval <function>ST_Intersection</function></funcdef>
 							<paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
-							<paramdef><type>integer </type> <parameter>band_num</parameter></paramdef>
-							<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
+							<paramdef><type>integer </type> <parameter>band</parameter></paramdef>
+							<paramdef><type>geometry </type> <parameter>geomin</parameter></paramdef>
 					  </funcprototype>
 
 					  <funcprototype>
@@ -8988,27 +8988,27 @@ FROM funky_shapes;
 							<funcdef>raster <function>ST_Intersection</function></funcdef>
 							<paramdef><type>raster </type> <parameter>rast1</parameter></paramdef>
 							<paramdef><type>raster </type> <parameter>rast2</parameter></paramdef>
-							<paramdef choice="opt"><type>text </type> <parameter>returnband='BOTH'</parameter></paramdef>
-							<paramdef choice="opt"><type>double precision[] </type> <parameter>nodataval=NULL</parameter></paramdef>
+							<paramdef choice="opt"><type>text </type> <parameter>returnband</parameter></paramdef>
+							<paramdef choice="opt"><type>double precision[] </type> <parameter>nodataval</parameter></paramdef>
 					  </funcprototype>
 
 					  <funcprototype>
 							<funcdef>raster <function>ST_Intersection</function></funcdef>
 							<paramdef><type>raster </type> <parameter>rast1</parameter></paramdef>
-							<paramdef><type>integer </type> <parameter>band_num1</parameter></paramdef>
+							<paramdef><type>integer </type> <parameter>band1</parameter></paramdef>
 							<paramdef><type>raster </type> <parameter>rast2</parameter></paramdef>
-							<paramdef><type>integer </type> <parameter>band_num2</parameter></paramdef>
+							<paramdef><type>integer </type> <parameter>band2</parameter></paramdef>
 							<paramdef><type>double precision[] </type> <parameter>nodataval</parameter></paramdef>
 					  </funcprototype>
 
 					  <funcprototype>
 							<funcdef>raster <function>ST_Intersection</function></funcdef>
 							<paramdef><type>raster </type> <parameter>rast1</parameter></paramdef>
-							<paramdef><type>integer </type> <parameter>band_num1</parameter></paramdef>
+							<paramdef><type>integer </type> <parameter>band1</parameter></paramdef>
 							<paramdef><type>raster </type> <parameter>rast2</parameter></paramdef>
-							<paramdef><type>integer </type> <parameter>band_num2</parameter></paramdef>
-							<paramdef choice="opt"><type>text </type> <parameter>returnband='BOTH'</parameter></paramdef>
-							<paramdef choice="opt"><type>double precision[] </type> <parameter>nodataval=NULL</parameter></paramdef>
+							<paramdef><type>integer </type> <parameter>band2</parameter></paramdef>
+							<paramdef choice="opt"><type>text </type> <parameter>returnband</parameter></paramdef>
+							<paramdef choice="opt"><type>double precision[] </type> <parameter>nodataval</parameter></paramdef>
 					  </funcprototype>
 
 					</funcsynopsis>
@@ -9041,7 +9041,7 @@ FROM funky_shapes;
 					</para>
 
 					<para>
-						In all variants, if no band number is specified band 1 is assumed.
+						In all variants, if no band number is specified band 1 is assumed.  If you need an intersection between a raster and geometry that returns a raster, refer to <xref linkend="RT_ST_Clip" />.
 					</para>
 
 					<note>
@@ -9104,12 +9104,6 @@ FROM (
 					</programlisting>
 				</refsection>
 
-				<refsection>
-					<title>Example: Raster, Geometry -- resulting is a raster</title>
-					<para>Examples coming soon</para>
-					<!-- TODO: EXAMPLES coming soon -->
-				</refsection>
-
 				<refsection>
 					<title>See Also</title>
 					<para>