From 6fdfaf5b63be922679e29b787161aa69448e5ba2 Mon Sep 17 00:00:00 2001
From: Chris Hill-Scott <me@quis.cc>
Date: Wed, 17 Jun 2020 15:28:37 +0100
Subject: [PATCH] Add description of SerialisedModel

---
 app/serialised_models.py | 8 ++++++++
 1 file changed, 8 insertions(+)

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):