Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Commit 40d7bf9

Browse files
author
Wes Kendall
committed
updated caveats section and fixed okes comment
1 parent 0a2753e commit 40d7bf9

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Let's start off with an example of two entities, an Account and a Group.
7171

7272
def get_entity_meta(self):
7373
"""
74-
Save the email and group of the Account as additional metaata.
74+
Save the email and group of the Account as additional metadata.
7575
"""
7676
return {
7777
'email': self.email,
@@ -139,3 +139,5 @@ One can also filter on the sub/super entities by their type. This is useful if t
139139

140140
## Caveats With Django Entity
141141
Django Entity has some current caveats worth noting. Currently, Djagno Entity links with post_save and post_delete signals so that any BaseEntityModel will be mirrored when updated. However, if the BaseEntityModel uses other models in its metadata or in defining its relationships to other models, these will not be updated when those other models are updated. For example, if there is a GroupMembership model that defines a if a User is active within a Group, changing the GroupMembership model will not remirror the Entity tables since GroupMembership does not inherit from BaseEntityModel. Future methods will be put in place to eliminate this caveat.
142+
143+
Note that if a user wishes to use a custom model manager for a BaseEntityModel, the user will have to make their model manager inherit EntityModelManager. If the user does not do this, entity syncing upon bulk methods will not work properly.

0 commit comments

Comments
 (0)