Add comment about scene name conventions (MCS-1814).

NextCenturyCorporation · Sep 13, 2023 · f7c0d1e · f7c0d1e
1 parent 234ecb3
commit f7c0d1e
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/webenabled/mcs_task_desc.py b/webenabled/mcs_task_desc.py
@@ -3,6 +3,14 @@
 
 @unique
 class TaskDescription(Enum):
+    """
+    The names for each enum correspond to the naming conventions currently
+    followed by all scenes checked into the webenabled/scenes directory.
+    Please note that any scenes not matching the naming conventions in this
+    file will likely not have their task description found to display in the
+    UI.
+    """
+
     # Interactive Tasks (in alphabetical order)
     INTERACTIVE_AGENT_IDENTIFICATION = (
         "Agent Identification tasks require a common-sense understanding of "