Merge pull request #44 from faulkner/fix-notes
Proper syntax for RST notes (so they actually render).
This commit is contained in:
commit
48f988acd7
@ -375,7 +375,7 @@ class DynamicDocument(Document):
|
|||||||
:class:`~mongoengine.DynamicField` and data can be attributed to that
|
:class:`~mongoengine.DynamicField` and data can be attributed to that
|
||||||
field.
|
field.
|
||||||
|
|
||||||
..note::
|
.. note::
|
||||||
|
|
||||||
There is one caveat on Dynamic Documents: fields cannot start with `_`
|
There is one caveat on Dynamic Documents: fields cannot start with `_`
|
||||||
"""
|
"""
|
||||||
|
@ -451,7 +451,7 @@ class GenericEmbeddedDocumentField(BaseField):
|
|||||||
|
|
||||||
Only valid values are subclasses of :class:`~mongoengine.EmbeddedDocument`.
|
Only valid values are subclasses of :class:`~mongoengine.EmbeddedDocument`.
|
||||||
|
|
||||||
..note :: You can use the choices param to limit the acceptable
|
.. note:: You can use the choices param to limit the acceptable
|
||||||
EmbeddedDocument types
|
EmbeddedDocument types
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@ -768,10 +768,10 @@ class GenericReferenceField(BaseField):
|
|||||||
"""A reference to *any* :class:`~mongoengine.document.Document` subclass
|
"""A reference to *any* :class:`~mongoengine.document.Document` subclass
|
||||||
that will be automatically dereferenced on access (lazily).
|
that will be automatically dereferenced on access (lazily).
|
||||||
|
|
||||||
..note :: Any documents used as a generic reference must be registered in the
|
.. note:: Any documents used as a generic reference must be registered in the
|
||||||
document registry. Importing the model will automatically register it.
|
document registry. Importing the model will automatically register it.
|
||||||
|
|
||||||
..note :: You can use the choices param to limit the acceptable Document types
|
.. note:: You can use the choices param to limit the acceptable Document types
|
||||||
|
|
||||||
.. versionadded:: 0.3
|
.. versionadded:: 0.3
|
||||||
"""
|
"""
|
||||||
|
Loading…
x
Reference in New Issue
Block a user