From 1ce2f84ce59f735b3f327020bf88c6d9792c59dc Mon Sep 17 00:00:00 2001 From: Ross Lawley Date: Wed, 11 Jul 2012 15:56:34 +0100 Subject: [PATCH] Updated docs regarding fields refs hmarr/mongoengine#535 --- docs/apireference.rst | 35 +++++++++++++++++++---------------- mongoengine/fields.py | 5 ++++- 2 files changed, 23 insertions(+), 17 deletions(-) diff --git a/docs/apireference.rst b/docs/apireference.rst index 304755fc..0f8901a1 100644 --- a/docs/apireference.rst +++ b/docs/apireference.rst @@ -47,25 +47,28 @@ Querying Fields ====== -.. autoclass:: mongoengine.StringField -.. autoclass:: mongoengine.URLField -.. autoclass:: mongoengine.EmailField -.. autoclass:: mongoengine.IntField -.. autoclass:: mongoengine.FloatField -.. autoclass:: mongoengine.DecimalField -.. autoclass:: mongoengine.DateTimeField +.. autoclass:: mongoengine.BinaryField +.. autoclass:: mongoengine.BooleanField .. autoclass:: mongoengine.ComplexDateTimeField -.. autoclass:: mongoengine.ListField -.. autoclass:: mongoengine.SortedListField +.. autoclass:: mongoengine.DateTimeField +.. autoclass:: mongoengine.DecimalField .. autoclass:: mongoengine.DictField +.. autoclass:: mongoengine.DynamicField +.. autoclass:: mongoengine.EmailField +.. autoclass:: mongoengine.EmbeddedDocumentField +.. autoclass:: mongoengine.FileField +.. autoclass:: mongoengine.FloatField +.. autoclass:: mongoengine.GenericEmbeddedDocumentField +.. autoclass:: mongoengine.GenericReferenceField +.. autoclass:: mongoengine.GeoPointField +.. autoclass:: mongoengine.ImageField +.. autoclass:: mongoengine.IntField +.. autoclass:: mongoengine.ListField .. autoclass:: mongoengine.MapField .. autoclass:: mongoengine.ObjectIdField .. autoclass:: mongoengine.ReferenceField -.. autoclass:: mongoengine.GenericReferenceField -.. autoclass:: mongoengine.EmbeddedDocumentField -.. autoclass:: mongoengine.GenericEmbeddedDocumentField -.. autoclass:: mongoengine.BooleanField -.. autoclass:: mongoengine.FileField -.. autoclass:: mongoengine.BinaryField -.. autoclass:: mongoengine.GeoPointField .. autoclass:: mongoengine.SequenceField +.. autoclass:: mongoengine.SortedListField +.. autoclass:: mongoengine.StringField +.. autoclass:: mongoengine.URLField +.. autoclass:: mongoengine.UUIDField diff --git a/mongoengine/fields.py b/mongoengine/fields.py index 1f865605..a4640dda 100644 --- a/mongoengine/fields.py +++ b/mongoengine/fields.py @@ -477,7 +477,10 @@ class GenericEmbeddedDocumentField(BaseField): class DynamicField(BaseField): - """Used by :class:`~mongoengine.DynamicDocument` to handle dynamic data""" + """A tryly dynamic field type capable of handling different and varying + types of data. + + Used by :class:`~mongoengine.DynamicDocument` to handle dynamic data""" def to_mongo(self, value): """Convert a Python type to a MongoDBcompatible type.