summaryrefslogtreecommitdiff
path: root/docs
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:58:56 +0100
commita55135418e1cf5f6107c682f89f6129b8407188d (patch)
treea15cc3f3921698073ff9e781f022365c2f16d027 /docs
parent494046542c3cd47e518775290e1a366b6998183b (diff)
[1.9.x] Fixed #25660 -- Documented GEOSGeometry.dims
Backport of f98126a05aeb1671c8036900a2720e21645318ad from master
Diffstat (limited to 'docs')
-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 c9979b415a..e206022ca0 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.