summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDanilo Bargen <mail@dbrgn.ch>2018-08-03 13:54:51 +0200
committerTim Graham <timograham@gmail.com>2018-08-03 10:39:25 -0400
commit4f9641c9af0c86578eb7ed1bb0273a1c8292fdc8 (patch)
tree6b748913f4468ca74bd9636380e87a62c7c1e8d1
parentc7060912256cc9af6d01d2cedd7f7b9b1efd8890 (diff)
[2.1.x] Fixed #29633 -- Doc'd the geometry type for each model field.
Backport of 2e06ff8e141d347b6b2991891bbac01fba0396d0 from master
-rw-r--r--docs/ref/contrib/gis/model-api.txt18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/ref/contrib/gis/model-api.txt b/docs/ref/contrib/gis/model-api.txt
index 5b2c2e414b..ac14af6272 100644
--- a/docs/ref/contrib/gis/model-api.txt
+++ b/docs/ref/contrib/gis/model-api.txt
@@ -34,46 +34,64 @@ Features specification [#fnogc]_. There is no such standard for raster data.
.. class:: GeometryField
+The base class for geometry fields.
+
``PointField``
--------------
.. class:: PointField
+Stores a :class:`~django.contrib.gis.geos.Point`.
+
``LineStringField``
-------------------
.. class:: LineStringField
+Stores a :class:`~django.contrib.gis.geos.LineString`.
+
``PolygonField``
----------------
.. class:: PolygonField
+Stores a :class:`~django.contrib.gis.geos.Polygon`.
+
``MultiPointField``
-------------------
.. class:: MultiPointField
+Stores a :class:`~django.contrib.gis.geos.MultiPoint`.
+
``MultiLineStringField``
------------------------
.. class:: MultiLineStringField
+Stores a :class:`~django.contrib.gis.geos.MultiLineString`.
+
``MultiPolygonField``
---------------------
.. class:: MultiPolygonField
+Stores a :class:`~django.contrib.gis.geos.MultiPolygon`.
+
``GeometryCollectionField``
---------------------------
.. class:: GeometryCollectionField
+Stores a :class:`~django.contrib.gis.geos.GeometryCollection`.
+
``RasterField``
---------------
.. class:: RasterField
+Stores a :class:`~django.contrib.gis.gdal.GDALRaster`.
+
``RasterField`` is currently only implemented for the PostGIS backend.
Spatial Field Options