From 1cb7feea507e4580ab1d17f0c642739189cb8217 Mon Sep 17 00:00:00 2001
From: Todd Dembrey <todd.dembrey@torchbox.com>
Date: Tue, 6 Mar 2018 14:29:38 +0000
Subject: [PATCH] Add some notes about the workflow classes

---
 opentech/apply/funds/workflow.py | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/opentech/apply/funds/workflow.py b/opentech/apply/funds/workflow.py
index 36dbc2ec8..1f621ec60 100644
--- a/opentech/apply/funds/workflow.py
+++ b/opentech/apply/funds/workflow.py
@@ -10,6 +10,15 @@ from django.utils.text import slugify
 This file defines classes which allow you to compose workflows based on the following structure:
 
 Workflow -> Stage -> Phase -> Action
+
+These classes are designed such that they can be mapped to a wagtail streamfield to allow admins
+to build/adjust workflows as required.
+
+Current limitations:
+* Changing the name of a phase will mean that any object which references it cannot progress. [will
+be fixed when streamfield, may require intermediate fix prior to launch]
+* Outcomes are a special case of phase and perhaps should be handled separately. [will look at when
+progressing stages]
 """
 
 
-- 
GitLab