pub/mongoengine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added missing fields to the api documentation

Browse Source
This commit is contained in:
Ross Lawley 2011-09-11 08:09:16 +01:00
parent 8105bfd8b3
commit 89c44cd14e
2 changed files with 14 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/apireference.rst
View File

@ -15,12 +15,12 @@ Documents
.. attribute:: objects .. attribute:: objects
A :class:`~mongoengine.queryset.QuerySet` object that is created lazily A :class:`~mongoengine.queryset.QuerySet` object that is created lazily
on access. on access.
.. autoclass:: mongoengine.EmbeddedDocument .. autoclass:: mongoengine.EmbeddedDocument
:members: :members:
.. autoclass:: mongoengine.document.MapReduceDocument .. autoclass:: mongoengine.document.MapReduceDocument
:members: :members:
@ -31,46 +31,31 @@ Querying
:members: :members:
.. automethod:: mongoengine.queryset.QuerySet.__call__ .. automethod:: mongoengine.queryset.QuerySet.__call__
.. autofunction:: mongoengine.queryset.queryset_manager .. autofunction:: mongoengine.queryset.queryset_manager
Fields Fields
====== ======
.. autoclass:: mongoengine.StringField .. autoclass:: mongoengine.StringField
.. autoclass:: mongoengine.URLField .. autoclass:: mongoengine.URLField
.. autoclass:: mongoengine.EmailField .. autoclass:: mongoengine.EmailField
.. autoclass:: mongoengine.IntField .. autoclass:: mongoengine.IntField
.. autoclass:: mongoengine.FloatField .. autoclass:: mongoengine.FloatField
.. autoclass:: mongoengine.DecimalField .. autoclass:: mongoengine.DecimalField
.. autoclass:: mongoengine.BooleanField
.. autoclass:: mongoengine.DateTimeField .. autoclass:: mongoengine.DateTimeField
.. autoclass:: mongoengine.ComplexDateTimeField .. autoclass:: mongoengine.ComplexDateTimeField
.. autoclass:: mongoengine.EmbeddedDocumentField
.. autoclass:: mongoengine.DictField
.. autoclass:: mongoengine.ListField .. autoclass:: mongoengine.ListField
.. autoclass:: mongoengine.SortedListField .. autoclass:: mongoengine.SortedListField
.. autoclass:: mongoengine.DictField
.. autoclass:: mongoengine.BinaryField .. autoclass:: mongoengine.MapField
.. autoclass:: mongoengine.ObjectIdField .. autoclass:: mongoengine.ObjectIdField
.. autoclass:: mongoengine.ReferenceField .. autoclass:: mongoengine.ReferenceField
.. autoclass:: mongoengine.GenericReferenceField .. autoclass:: mongoengine.GenericReferenceField
.. autoclass:: mongoengine.EmbeddedDocumentField
.. autoclass:: mongoengine.GenericEmbeddedDocumentField
.. autoclass:: mongoengine.BooleanField
.. autoclass:: mongoengine.FileField .. autoclass:: mongoengine.FileField
.. autoclass:: mongoengine.BinaryField
.. autoclass:: mongoengine.GeoPointField .. autoclass:: mongoengine.GeoPointField
.. autoclass:: mongoengine.SequenceField

6
mongoengine/fields.py
View File

@ -920,9 +920,11 @@ class GeoPointField(BaseField):
class SequenceField(IntField): 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 numbers for primary keys. In MongoDB, the preferred approach is to
use Object IDs instead. The concept is that in a very large 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 cluster of machines, it is easier to create an object ID than have