diff --git a/app/serialised_models.py b/app/serialised_models.py index fdce2438e..beeea3b1a 100644 --- a/app/serialised_models.py +++ b/app/serialised_models.py @@ -3,6 +3,14 @@ from abc import ABC, abstractmethod class SerialisedModel(ABC): + """ + A SerialisedModel takes a dictionary, typically created by + serialising a database object. It then takes the value of specified + keys from the dictionary and adds them to itself as properties, so + that it can be interacted with like a normal database model object, + but with no risk that it will actually go back to the database. + """ + @property @abstractmethod def ALLOWED_PROPERTIES(self):