From: Sandro Santilli Date: Wed, 15 Jun 2016 14:21:00 +0000 (+0000) Subject: Shorten refpurpose sections, always use first person X-Git-Tag: 2.3.0beta1~80 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a64fbfd17896141508fb3ee92b763ef5533ba329;p=postgis Shorten refpurpose sections, always use first person git-svn-id: http://svn.osgeo.org/postgis/trunk@14950 b70326c6-7e19-0410-871a-916f4a2858ee --- diff --git a/doc/reference_editor.xml b/doc/reference_editor.xml index 6aa3d37ff..fedff4f1d 100644 --- a/doc/reference_editor.xml +++ b/doc/reference_editor.xml @@ -5,8 +5,7 @@ ST_AddPoint - Adds a point to a LineString before point <position> - (0-based index). + Add a point to a LineString. @@ -66,7 +65,7 @@ ST_Affine - Applies a 3d affine transformation to the geometry to do things like translate, rotate, scale in one step. + Apply a 3d affine transformation to a geometry. @@ -174,8 +173,7 @@ SELECT ST_AsEWKT(ST_Affine(the_geom, cos(pi()), -sin(pi()), 0, sin(pi()), cos(pi ST_Force2D - Forces the geometries into a "2-dimensional mode" so that - all output representations will only have the X and Y coordinates. + Force the geometries into a "2-dimensional mode". @@ -232,7 +230,7 @@ SELECT ST_AsEWKT(ST_Force2D('POLYGON((0 0 2,0 5 2,5 0 2,0 0 2),(1 1 2,3 1 2,1 3 ST_Force3D - Forces the geometries into XYZ mode. This is an alias for ST_Force3DZ. + Force the geometries into XYZ mode. This is an alias for ST_Force3DZ. @@ -288,7 +286,7 @@ SELECT ST_AsEWKT(ST_Force3D('POLYGON((0 0,0 5,5 0,0 0),(1 1,3 1,1 3,1 1))')); ST_Force3DZ - Forces the geometries into XYZ mode. This is a synonym for ST_Force3D. + Force the geometries into XYZ mode. @@ -344,7 +342,7 @@ SELECT ST_AsEWKT(ST_Force3DZ('POLYGON((0 0,0 5,5 0,0 0),(1 1,3 1,1 3,1 1))')); ST_Force3DM - Forces the geometries into XYM mode. + Force the geometries into XYM mode. @@ -399,7 +397,7 @@ SELECT ST_AsEWKT(ST_Force3DM('POLYGON((0 0 1,0 5 1,5 0 1,0 0 1),(1 1 1,3 1 1,1 ST_Force4D - Forces the geometries into XYZM mode. + Force the geometries into XYZM mode. @@ -455,7 +453,7 @@ SELECT ST_AsEWKT(ST_Force4D('MULTILINESTRINGM((0 0 1,0 5 2,5 0 3,0 0 4),(1 1 1, ST_ForceCollection - Converts the geometry into a GEOMETRYCOLLECTION. + Convert the geometry into a GEOMETRYCOLLECTION. @@ -538,7 +536,7 @@ GEOMETRYCOLLECTION( ST_ForceSFS - Forces the geometries to use SFS 1.1 geometry types only. + Force the geometries to use SFS 1.1 geometry types only. @@ -570,7 +568,7 @@ GEOMETRYCOLLECTION( ST_ForceRHR - Forces the orientation of the vertices in a polygon to follow the + Force the orientation of the vertices in a polygon to follow the Right-Hand-Rule. @@ -625,7 +623,7 @@ GEOMETRYCOLLECTION( ST_ForceCurve - Upcasts a geometry into its curved type, if applicable. + Upcast a geometry into its curved type, if applicable. @@ -678,7 +676,7 @@ GEOMETRYCOLLECTION( ST_LineMerge - Returns a (set of) LineString(s) formed by sewing together + Return a (set of) LineString(s) formed by sewing together a MULTILINESTRING. @@ -736,7 +734,7 @@ MULTILINESTRING((-45.2 -33.2,-46 -32),(-29 -27,-30 -29.7,-36 -31,-45 -33)) ST_CollectionExtract -Given a (multi)geometry, returns a (multi)geometry consisting only of elements of the specified type. +Given a (multi)geometry, return a (multi)geometry consisting only of elements of the specified type. @@ -800,7 +798,7 @@ MULTILINESTRING((0 0, 1 1), (2 2, 3 3)) ST_CollectionHomogenize - Given a geometry collection, returns the "simplest" representation of the contents. + Given a geometry collection, return the "simplest" representation of the contents. @@ -858,8 +856,7 @@ MULTILINESTRING((0 0, 1 1), (2 2, 3 3)) ST_Multi - Returns the geometry as a MULTI* geometry. If the geometry - is already a MULTI*, it is returned unchanged. + Return the geometry as a MULTI* geometry. @@ -901,7 +898,7 @@ MULTILINESTRING((0 0, 1 1), (2 2, 3 3)) ST_Normalize - Returns the geometry in its canonical form. + Return the geometry in its canonical form. @@ -961,7 +958,7 @@ SELECT ST_AsText(ST_Normalize(ST_GeomFromText( ST_RemovePoint - Removes point from a linestring. Offset is 0-based. + Remove point from a linestring. @@ -976,7 +973,7 @@ SELECT ST_AsText(ST_Normalize(ST_GeomFromText( Description - Removes point from a linestring. Useful for turning a closed ring into an open line string + Remove a point from a linestring, given its 0-based index. Useful for turning a closed ring into an open line string Availability: 1.1.0 &Z_support; @@ -1001,7 +998,7 @@ UPDATE sometable ST_Reverse - Returns the geometry with vertex order reversed. + Return the geometry with vertex order reversed. @@ -1299,10 +1296,7 @@ FROM (SELECT ST_LineToCurve(ST_Buffer(ST_GeomFromText('POINT(234 567)'), 3)) As ST_Scale - Scales the geometry to a new size by multiplying the - ordinates with the parameters. Ie: ST_Scale(geom, Xfactor, Yfactor, - Zfactor). - + Scale a geometry by given factors. @@ -1397,8 +1391,7 @@ SELECT ST_AsEWKT(ST_Scale(ST_GeomFromEWKT('LINESTRING(1 2 3, 1 1 1)'), 0.5, 0.75 ST_Segmentize Return a modified geometry/geography having no segment longer than the - given distance. Distance computation is performed in 2d - only. For geometry, length units are in units of spatial reference. For geography, units are in meters. + given distance. @@ -1461,8 +1454,7 @@ POLYGON((-29 28,-29.8304547985374 37.9654575824488,-30 40,-29.1695452014626 30.0 ST_SetPoint - Replace point N of linestring with given point. Index is - 0-based. Negative indexes are counted backwards, so that -1 is the last point. + Replace point of a linestring with a given point. @@ -1522,7 +1514,7 @@ LINESTRING(0 0,1 1,0 0,3 3,4 4) ST_SetSRID - Sets the SRID on a geometry to a particular integer + Set the SRID on a geometry to a particular integer value. @@ -1915,7 +1907,7 @@ LINESTRING(26 125,54 84,101 100) ST_Transform - Returns a new geometry with its coordinates transformed to + Return a new geometry with its coordinates transformed to a different spatial reference. @@ -2078,8 +2070,7 @@ CREATE INDEX idx_the_geom_26986_parcels ST_Translate - Translates the geometry to a new location using the numeric - parameters as offsets. Ie: ST_Translate(geom, X, Y) or ST_Translate(geom, X, Y,Z). + Translate a geometry by given offsets. @@ -2154,9 +2145,7 @@ CREATE INDEX idx_the_geom_26986_parcels ST_TransScale - Translates the geometry using the deltaX and deltaY args, - then scales it using the XFactor, YFactor args, working in 2D only. - + Translate a geometry by given factors and offsets.