summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorSergey Fedoseev <fedoseev.sergey@gmail.com>2015-11-03 17:16:08 +0500
committerTim Graham <timograham@gmail.com>2015-11-05 10:59:00 +0100
commita71fc544c6913c5d204590d57fbb32a6bf7af08c (patch)
treec9ebe771912625267b65406df96ae1e8345420c3 /docs/ref
parenta31973c7c519234a07c1ec779fbc0bb424bcc702 (diff)
[1.8.x] Fixed #25660 -- Documented GEOSGeometry.dims
Backport of f98126a05aeb1671c8036900a2720e21645318ad from master
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/contrib/gis/geos.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/ref/contrib/gis/geos.txt b/docs/ref/contrib/gis/geos.txt
index f856a96723..ac045f4452 100644
--- a/docs/ref/contrib/gis/geos.txt
+++ b/docs/ref/contrib/gis/geos.txt
@@ -172,6 +172,17 @@ Properties
Returns the coordinates of the geometry as a tuple.
+.. attribute:: GEOSGeometry.dims
+
+Returns the dimension of the geometry:
+
+* ``0`` for :class:`Point`\s and :class:`MultiPoint`\s
+* ``1`` for :class:`LineString`\s and :class:`MultiLineString`\s
+* ``2`` for :class:`Polygon`\s and :class:`MultiPolygon`\s
+* ``-1`` for empty :class:`GeometryCollection`\s
+* the maximum dimension of its elements for non-empty
+ :class:`GeometryCollection`\s
+
.. attribute:: GEOSGeometry.empty
Returns whether or not the set of points in the geometry is empty.