Merge pull request #613 from falcondai/master
minor change to geo-related docs
This commit is contained in:
		| @@ -531,6 +531,8 @@ field name to the index definition. | |||||||
| Sometimes its more efficient to index parts of Embedded / dictionary fields, | Sometimes its more efficient to index parts of Embedded / dictionary fields, | ||||||
| in this case use 'dot' notation to identify the value to index eg: `rank.title` | in this case use 'dot' notation to identify the value to index eg: `rank.title` | ||||||
|  |  | ||||||
|  | .. _geospatial-indexes: | ||||||
|  |  | ||||||
| Geospatial indexes | Geospatial indexes | ||||||
| ------------------ | ------------------ | ||||||
|  |  | ||||||
|   | |||||||
| @@ -1613,7 +1613,12 @@ class UUIDField(BaseField): | |||||||
|  |  | ||||||
|  |  | ||||||
| class GeoPointField(BaseField): | class GeoPointField(BaseField): | ||||||
|     """A list storing a latitude and longitude. |     """A list storing a longitude and latitude coordinate.  | ||||||
|  |  | ||||||
|  |     .. note:: this represents a generic point in a 2D plane and a legacy way of  | ||||||
|  |         representing a geo point. It admits 2d indexes but not "2dsphere" indexes  | ||||||
|  |         in MongoDB > 2.4 which are more natural for modeling geospatial points.  | ||||||
|  |         See :ref:`geospatial-indexes`  | ||||||
|  |  | ||||||
|     .. versionadded:: 0.4 |     .. versionadded:: 0.4 | ||||||
|     """ |     """ | ||||||
| @@ -1635,7 +1640,7 @@ class GeoPointField(BaseField): | |||||||
|  |  | ||||||
|  |  | ||||||
| class PointField(GeoJsonBaseField): | class PointField(GeoJsonBaseField): | ||||||
|     """A geo json field storing a latitude and longitude. |     """A GeoJSON field storing a longitude and latitude coordinate. | ||||||
|  |  | ||||||
|     The data is represented as: |     The data is represented as: | ||||||
|  |  | ||||||
| @@ -1654,7 +1659,7 @@ class PointField(GeoJsonBaseField): | |||||||
|  |  | ||||||
|  |  | ||||||
| class LineStringField(GeoJsonBaseField): | class LineStringField(GeoJsonBaseField): | ||||||
|     """A geo json field storing a line of latitude and longitude coordinates. |     """A GeoJSON field storing a line of longitude and latitude coordinates. | ||||||
|  |  | ||||||
|     The data is represented as: |     The data is represented as: | ||||||
|  |  | ||||||
| @@ -1672,7 +1677,7 @@ class LineStringField(GeoJsonBaseField): | |||||||
|  |  | ||||||
|  |  | ||||||
| class PolygonField(GeoJsonBaseField): | class PolygonField(GeoJsonBaseField): | ||||||
|     """A geo json field storing a polygon of latitude and longitude coordinates. |     """A GeoJSON field storing a polygon of longitude and latitude coordinates. | ||||||
|  |  | ||||||
|     The data is represented as: |     The data is represented as: | ||||||
|  |  | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user