Bläddra i källkod

Fixed #29633 -- Doc'd the geometry type for each model field.

Danilo Bargen 6 år sedan
förälder
incheckning
2e06ff8e14
1 ändrade filer med 18 tillägg och 0 borttagningar
  1. 18 0
      docs/ref/contrib/gis/model-api.txt

+ 18 - 0
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