From 708c3f1e2a416523a55128dbe1bcc5a374b9a910 Mon Sep 17 00:00:00 2001 From: Axel Haustant Date: Thu, 28 Aug 2014 19:42:09 +0200 Subject: [PATCH] Added new geospatial fields to th documentation --- docs/apireference.rst | 3 +++ docs/changelog.rst | 1 + docs/guide/defining-documents.rst | 9 +++++++++ 3 files changed, 13 insertions(+) diff --git a/docs/apireference.rst b/docs/apireference.rst index 9b4f2c66..857a14b0 100644 --- a/docs/apireference.rst +++ b/docs/apireference.rst @@ -95,6 +95,9 @@ Fields .. autoclass:: mongoengine.fields.PointField .. autoclass:: mongoengine.fields.LineStringField .. autoclass:: mongoengine.fields.PolygonField +.. autoclass:: mongoengine.fields.MultiPointField +.. autoclass:: mongoengine.fields.MultiLineStringField +.. autoclass:: mongoengine.fields.MultiPolygonField .. autoclass:: mongoengine.fields.GridFSError .. autoclass:: mongoengine.fields.GridFSProxy .. autoclass:: mongoengine.fields.ImageGridFsProxy diff --git a/docs/changelog.rst b/docs/changelog.rst index 94dbcf3c..4bc01801 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -52,6 +52,7 @@ Changes in 0.9.X - DEV - index_cls is ignored when deciding to set _cls as index prefix #733 - Make 'db' argument to connection optional #737 - Allow atomic update for the entire `DictField` #742 +- Added MultiPointField, MultiLineField, MultiPolygonField Changes in 0.8.7 ================ diff --git a/docs/guide/defining-documents.rst b/docs/guide/defining-documents.rst index ddc37eae..8db991c1 100644 --- a/docs/guide/defining-documents.rst +++ b/docs/guide/defining-documents.rst @@ -91,6 +91,12 @@ are as follows: * :class:`~mongoengine.fields.StringField` * :class:`~mongoengine.fields.URLField` * :class:`~mongoengine.fields.UUIDField` +* :class:`~mongoengine.fields.PointField` +* :class:`~mongoengine.fields.LineStringField` +* :class:`~mongoengine.fields.PolygonField` +* :class:`~mongoengine.fields.MultiPointField` +* :class:`~mongoengine.fields.MultiLineStringField` +* :class:`~mongoengine.fields.MultiPolygonField` Field arguments --------------- @@ -544,6 +550,9 @@ The following fields will explicitly add a "2dsphere" index: - :class:`~mongoengine.fields.PointField` - :class:`~mongoengine.fields.LineStringField` - :class:`~mongoengine.fields.PolygonField` + - :class:`~mongoengine.fields.MultiPointField` + - :class:`~mongoengine.fields.MultiLineStringField` + - :class:`~mongoengine.fields.MultiPolygonField` As "2dsphere" indexes can be part of a compound index, you may not want the automatic index but would prefer a compound index. In this example we turn off