Document SurveyCancellerSupervisor's behaviour

See #2337
instedd · May 9, 2024 · c96c29b · c96c29b
1 parent e46eb19
commit c96c29b
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lib/ask/runtime/survey_canceller_supervisor.ex b/lib/ask/runtime/survey_canceller_supervisor.ex
@@ -33,6 +33,11 @@ defmodule Ask.Runtime.SurveyCancellerSupervisor do
     }
   end
 
+  # The SurveyCancellerSupervisor makes sure every cancelling Survey
+  # effectively gets cancelled. Upon startup, it checks and starts a
+  # SurveyCanceller process for each survey pending of cancellation, and
+  # then it also starts new cancellers on demand when a new survey gets
+  # cancelled.
   @impl true
   def init(_init_arg) do
     processes_to_start =