From 0bb66bbe15ada2f88a7b7f4d3db18d2a04eff903 Mon Sep 17 00:00:00 2001
From: Felix Stupp <felix.stupp@banananet.work>
Date: Thu, 22 Feb 2024 12:10:38 +0100
Subject: [PATCH] transport/datagrams/failure: explain meaning

---
 enjo_lib/comm/transport/datagrams.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/enjo_lib/comm/transport/datagrams.py b/enjo_lib/comm/transport/datagrams.py
index b40129d..d46e7db 100644
--- a/enjo_lib/comm/transport/datagrams.py
+++ b/enjo_lib/comm/transport/datagrams.py
@@ -90,6 +90,13 @@ class FailureDatagram(GeneralTransportDatagram):
 
 @serializable
 class FailureMetadata(GeneralTransportMetadata):
+    """
+    Issues that a specific service has failed.
+
+    This does not mean that the whole stack might be failed as each service may run on its own.
+    But most certainly, if the controller does issue an failure, it likely is the whole stack.
+    """
+
     epoch: EpochId
     reason: HumanFriendlyDesc