Skip to content

Commit 41a8e07

Browse files
jawwad-aliclaude
andauthored
docs(workflows): fix stale FanOutStep docstring claiming sequential-only execution (#3639)
The FanOutStep class docstring stated that fan-out execution is "currently sequential" and that `max_concurrency` is "accepted but not enforced". That has been inaccurate since #3224, which added a bounded thread-pool concurrency path to `WorkflowEngine._run_fan_out` that honors `max_concurrency > 1`. Update the docstring to match the engine's own `_run_fan_out` docstring: `max_concurrency <= 1` (the default) runs items sequentially, while `> 1` runs up to that many items concurrently on a bounded thread pool. Docstring-only; no behavior change. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 01d07e2 commit 41a8e07

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

src/specify_cli/workflows/steps/fan_out/__init__.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ class FanOutStep(StepBase):
1212
"""Dispatch a step template for each item in a collection.
1313
1414
The engine executes the nested ``step:`` template once per item,
15-
setting ``context.item`` for each iteration. Execution is
16-
currently sequential; ``max_concurrency`` is accepted but not
17-
enforced.
15+
setting ``context.item`` for each iteration. ``max_concurrency``
16+
controls parallelism: ``<= 1`` (the default) runs items
17+
sequentially, while ``> 1`` runs up to that many items concurrently
18+
on a bounded thread pool (see ``WorkflowEngine._run_fan_out``).
1819
"""
1920

2021
type_key = "fan-out"

0 commit comments

Comments
 (0)