summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRaphaël Barrois <raphael.barrois@polyconseil.fr>2013-12-25 01:26:06 +0100
committerRaphaël Barrois <raphael.barrois@polyconseil.fr>2013-12-25 01:26:32 +0100
commit8a014a343050625b8d30db5a8fa608b875b018c4 (patch)
tree2dc0f9c91ec79b0957989a43836d84d9ddd7fe31
parent924d8a6ac279ca6ad560a3cf5efa1b141cedd253 (diff)
downloadfactory-boy-8a014a343050625b8d30db5a8fa608b875b018c4.tar
factory-boy-8a014a343050625b8d30db5a8fa608b875b018c4.tar.gz
Add doc for MongoEngineFactory's support of EmbeddedDocument.
Closes #100, #112.
-rw-r--r--docs/changelog.rst1
-rw-r--r--docs/orms.rst5
2 files changed, 6 insertions, 0 deletions
diff --git a/docs/changelog.rst b/docs/changelog.rst
index 09de792..c9d7e2f 100644
--- a/docs/changelog.rst
+++ b/docs/changelog.rst
@@ -11,6 +11,7 @@ ChangeLog
- Add :class:`~factory.fuzzy.FuzzyText`, thanks to `jdufresne <https://github.com/jdufresne>`_ (:issue:`97`)
- Add :class:`~factory.fuzzy.FuzzyDecimal`, thanks to `thedrow <https://github.com/thedrow>`_ (:issue:`94`)
+ - Add support for :class:`~mongoengine.EmbeddedDocument`, thanks to `imiric <https://github.com/imiric>`_ (:issue:`100`)
.. _v2.2.1:
diff --git a/docs/orms.rst b/docs/orms.rst
index b720ed1..e50e706 100644
--- a/docs/orms.rst
+++ b/docs/orms.rst
@@ -200,6 +200,11 @@ factory_boy supports `MongoEngine`_-style models, through the :class:`MongoEngin
* :func:`~factory.Factory.create()` builds an instance through ``__init__`` then
saves it.
+ .. note:: If the :attr:`associated class <factory.Factory.FACTORY_FOR>` is a :class:`mongoengine.EmbeddedDocument`,
+ the :meth:`~MongoEngineFactory.create` function won't "save" it, since this wouldn't make sense.
+
+ This feature makes it possible to use :class:`~factory.SubFactory` to create embedded document.
+
SQLAlchemy
----------