Skip to content

💫 Toolkit to help you get started with SDD or any other process!

docs(workflows): fix stale FanOutStep docstring claiming sequential-only execution (#3639)

Ali jawwad41a8e07f4cd6
diff --git a/src/specify_cli/workflows/steps/fan_out/__init__.py b/src/specify_cli/workflows/steps/fan_out/__init__.py
index 81cf4f8d5..d961170c8 100644
--- a/src/specify_cli/workflows/steps/fan_out/__init__.py
+++ b/src/specify_cli/workflows/steps/fan_out/__init__.py
@@ -12,9 +12,10 @@ class FanOutStep(StepBase):
"""Dispatch a step template for each item in a collection.
The engine executes the nested ``step:`` template once per item,
- setting ``context.item`` for each iteration. Execution is
- currently sequential; ``max_concurrency`` is accepted but not
- enforced.
+ setting ``context.item`` for each iteration. ``max_concurrency``
+ controls parallelism: ``<= 1`` (the default) runs items
+ sequentially, while ``> 1`` runs up to that many items concurrently
+ on a bounded thread pool (see ``WorkflowEngine._run_fan_out``).
"""
type_key = "fan-out"