From 4b498ae8cd845b0f6ac34f8823fff0b964703c14 Mon Sep 17 00:00:00 2001 From: David Czarnecki Date: Fri, 31 Oct 2014 11:40:20 -0400 Subject: [PATCH] Fix the documentation for reverse_delete_rule. --- docs/guide/signals.rst | 2 +- mongoengine/fields.py | 4 ++-- tests/document/instance.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/guide/signals.rst b/docs/guide/signals.rst index dc295d47..fc93e4ca 100644 --- a/docs/guide/signals.rst +++ b/docs/guide/signals.rst @@ -145,7 +145,7 @@ cleaner looking while still allowing manual execution of the callback:: ReferenceFields and Signals --------------------------- -Currently `reverse_delete_rules` do not trigger signals on the other part of +Currently `reverse_delete_rule` does not trigger signals on the other part of the relationship. If this is required you must manually handle the reverse deletion. diff --git a/mongoengine/fields.py b/mongoengine/fields.py index 2441a754..870d09e5 100644 --- a/mongoengine/fields.py +++ b/mongoengine/fields.py @@ -859,7 +859,7 @@ class ReferenceField(BaseField): Use the `reverse_delete_rule` to handle what should happen if the document the field is referencing is deleted. EmbeddedDocuments, DictFields and - MapFields do not support reverse_delete_rules and an `InvalidDocumentError` + MapFields does not support reverse_delete_rule and an `InvalidDocumentError` will be raised if trying to set on one of these Document / Field types. The options are: @@ -883,7 +883,7 @@ class ReferenceField(BaseField): Bar.register_delete_rule(Foo, 'bar', NULLIFY) .. note :: - `reverse_delete_rules` do not trigger pre / post delete signals to be + `reverse_delete_rule` does not trigger pre / post delete signals to be triggered. .. versionchanged:: 0.5 added `reverse_delete_rule` diff --git a/tests/document/instance.py b/tests/document/instance.py index f925aeeb..c226b614 100644 --- a/tests/document/instance.py +++ b/tests/document/instance.py @@ -1795,7 +1795,7 @@ class InstanceTest(unittest.TestCase): self.assertEqual(Bar.objects.count(), 1) # No effect on the BlogPost self.assertEqual(Bar.objects.get().foo, None) - def test_invalid_reverse_delete_rules_raise_errors(self): + def test_invalid_reverse_delete_rule_raise_errors(self): def throw_invalid_document_error(): class Blog(Document):