Updated docs regarding fields

refs hmarr/mongoengine#535
This commit is contained in:
Ross Lawley 2012-07-11 15:56:34 +01:00
parent f55b241cfa
commit 1ce2f84ce5
2 changed files with 23 additions and 17 deletions

View File

@ -47,25 +47,28 @@ Querying
Fields Fields
====== ======
.. autoclass:: mongoengine.StringField .. autoclass:: mongoengine.BinaryField
.. autoclass:: mongoengine.URLField .. autoclass:: mongoengine.BooleanField
.. autoclass:: mongoengine.EmailField
.. autoclass:: mongoengine.IntField
.. autoclass:: mongoengine.FloatField
.. autoclass:: mongoengine.DecimalField
.. autoclass:: mongoengine.DateTimeField
.. autoclass:: mongoengine.ComplexDateTimeField .. autoclass:: mongoengine.ComplexDateTimeField
.. autoclass:: mongoengine.ListField .. autoclass:: mongoengine.DateTimeField
.. autoclass:: mongoengine.SortedListField .. autoclass:: mongoengine.DecimalField
.. autoclass:: mongoengine.DictField .. 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.MapField
.. autoclass:: mongoengine.ObjectIdField .. autoclass:: mongoengine.ObjectIdField
.. autoclass:: mongoengine.ReferenceField .. 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.SequenceField
.. autoclass:: mongoengine.SortedListField
.. autoclass:: mongoengine.StringField
.. autoclass:: mongoengine.URLField
.. autoclass:: mongoengine.UUIDField

View File

@ -477,7 +477,10 @@ class GenericEmbeddedDocumentField(BaseField):
class DynamicField(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): def to_mongo(self, value):
"""Convert a Python type to a MongoDBcompatible type. """Convert a Python type to a MongoDBcompatible type.