From 89c44cd14eb77d6f778789260344f9de7659c2be Mon Sep 17 00:00:00 2001 From: Ross Lawley Date: Sun, 11 Sep 2011 08:09:16 +0100 Subject: [PATCH] Added missing fields to the api documentation --- docs/apireference.rst | 35 ++++++++++------------------------- mongoengine/fields.py | 6 ++++-- 2 files changed, 14 insertions(+), 27 deletions(-) diff --git a/docs/apireference.rst b/docs/apireference.rst index 2442803d..57472dc8 100644 --- a/docs/apireference.rst +++ b/docs/apireference.rst @@ -15,12 +15,12 @@ Documents .. attribute:: objects - A :class:`~mongoengine.queryset.QuerySet` object that is created lazily + A :class:`~mongoengine.queryset.QuerySet` object that is created lazily on access. .. autoclass:: mongoengine.EmbeddedDocument :members: - + .. autoclass:: mongoengine.document.MapReduceDocument :members: @@ -31,46 +31,31 @@ Querying :members: .. automethod:: mongoengine.queryset.QuerySet.__call__ - + .. autofunction:: mongoengine.queryset.queryset_manager Fields ====== .. autoclass:: mongoengine.StringField - .. autoclass:: mongoengine.URLField - .. autoclass:: mongoengine.EmailField - .. autoclass:: mongoengine.IntField - .. autoclass:: mongoengine.FloatField - .. autoclass:: mongoengine.DecimalField - -.. autoclass:: mongoengine.BooleanField - .. autoclass:: mongoengine.DateTimeField - .. autoclass:: mongoengine.ComplexDateTimeField - -.. autoclass:: mongoengine.EmbeddedDocumentField - -.. autoclass:: mongoengine.DictField - .. autoclass:: mongoengine.ListField - .. autoclass:: mongoengine.SortedListField - -.. autoclass:: mongoengine.BinaryField - +.. autoclass:: mongoengine.DictField +.. 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 diff --git a/mongoengine/fields.py b/mongoengine/fields.py index c5734430..fa993522 100644 --- a/mongoengine/fields.py +++ b/mongoengine/fields.py @@ -920,9 +920,11 @@ class GeoPointField(BaseField): class SequenceField(IntField): - """Provides a sequental counter. + """Provides a sequental counter (see http://www.mongodb.org/display/DOCS/Object+IDs#ObjectIDs-SequenceNumbers) - ..note:: Although traditional databases often use increasing sequence + .. note:: + + Although traditional databases often use increasing sequence numbers for primary keys. In MongoDB, the preferred approach is to use Object IDs instead. The concept is that in a very large cluster of machines, it is easier to create an object ID than have