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

fields.ReferenceField: add integer values to reverse_delete_rule docs

Browse Source 
When I first tried to use the `reverse_delete_rule` feature of
`ReferenceField`, I had to dig through the source code to find what the
actual integer values were expected to be for DO_NOTHING, NULLIFY,
CASCADE, DENY, and PULL (or at least, where these constants were defined
so that I could import and use them). This patch adds the integer values
for those constants (which are defined in mongoengine.queryset.base) to
the docs so that users can easily choose the correct integer value.

Note: A possible improvement on this change would be to include
`mongoengine.queryset.base` module documentation in the generated docs,
and then update the `ReferenceField` docs to link to the documentation
of these constants (DO_NOTHING, NULLIFY, etc.).
This commit is contained in:
Lars Butler 2015-10-05 14:31:41 +02:00
parent 903982e896
commit 5a038de1d5
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
mongoengine/fields.py
View File

@ -863,12 +863,11 @@ class ReferenceField(BaseField):
The options are: The options are:
* DO_NOTHING - don't do anything (default). * DO_NOTHING (0) - don't do anything (default).
* NULLIFY - Updates the reference to null. * NULLIFY (1) - Updates the reference to null.
* CASCADE - Deletes the documents associated with the reference. * CASCADE (2) - Deletes the documents associated with the reference.
* DENY - Prevent the deletion of the reference object. * DENY (3) - Prevent the deletion of the reference object.
* PULL - Pull the reference from a :class:`~mongoengine.fields.ListField` * PULL (4) - Pull the reference from a :class:`~mongoengine.fields.ListField` of references
of references
Alternative syntax for registering delete rules (useful when implementing Alternative syntax for registering delete rules (useful when implementing
bi-directional delete rules) bi-directional delete rules)