diff options
| author | Raphaël Barrois <raphael.barrois@polytechnique.org> | 2013-04-29 23:00:32 +0200 |
|---|---|---|
| committer | Raphaël Barrois <raphael.barrois@polytechnique.org> | 2013-04-29 23:02:08 +0200 |
| commit | 38dfde05f5be3cdd69e6fee66e7968b776b0ed9f (patch) | |
| tree | 7b4ba1cec98b002150f372e351aefff58ec7ef4d /docs | |
| parent | 3b75e132fd1f302b604e76f4c1a0361c32ba50d4 (diff) | |
| download | factory-boy-38dfde05f5be3cdd69e6fee66e7968b776b0ed9f.tar factory-boy-38dfde05f5be3cdd69e6fee66e7968b776b0ed9f.tar.gz | |
declarations: Rename RelatedFactory.name (See #58).
Use less conflict-prone factory_related_name.
Signed-off-by: Raphaël Barrois <raphael.barrois@polytechnique.org>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/changelog.rst | 4 | ||||
| -rw-r--r-- | docs/reference.rst | 4 |
2 files changed, 6 insertions, 2 deletions
diff --git a/docs/changelog.rst b/docs/changelog.rst index f072b1c..da22b13 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -9,6 +9,10 @@ ChangeLog - Add :class:`~factory.fuzzy.FuzzyDate` thanks to `saulshanabrook <https://github.com/saulshanabrook>`_ - Add :class:`~factory.fuzzy.FuzzyDateTime` and :class:`~factory.fuzzy.FuzzyNaiveDateTime`. +*Deprecation:* + + - Rename :class:`~factory.RelatedFactory`'s ``name`` argument to ``factory_related_name`` (See #58) + 2.0.2 (2013-04-16) ------------------ diff --git a/docs/reference.rst b/docs/reference.rst index ad91a8d..09d9ceb 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -1025,7 +1025,7 @@ as keyword arguments; ``{'post_x': 2}`` will be passed to ``SomeFactory.FACTORY_ RelatedFactory """""""""""""" -.. class:: RelatedFactory(factory, name='', **kwargs) +.. class:: RelatedFactory(factory, factory_related_name='', **kwargs) .. OHAI_VIM** @@ -1045,7 +1045,7 @@ RelatedFactory .. attribute:: name The generated object (where the :class:`RelatedFactory` attribute will - set) may be passed to the related factory if the :attr:`name` parameter + set) may be passed to the related factory if the :attr:`factory_related_name` parameter is set. It will be passed as a keyword argument, using the :attr:`name` value as |