docs(workflows): fix stale FanOutStep docstring claiming sequential-only execution#3639
Merged
mnriem merged 1 commit intoJul 22, 2026
Merged
Conversation
…nly execution 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 github#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>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the FanOutStep docstring to reflect the existing bounded concurrency behavior.
Changes:
- Documents sequential execution for
max_concurrency <= 1. - Documents bounded thread-pool execution for values above 1.
Show a summary per file
| File | Description |
|---|---|
src/specify_cli/workflows/steps/fan_out/__init__.py |
Corrects stale fan-out concurrency documentation. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Medium
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The
FanOutStepclass docstring (src/specify_cli/workflows/steps/fan_out/__init__.py) still claims:That has been inaccurate since #3224 (
feat(workflows): honor max_concurrency in fan-out via a bounded thread pool), which added a real bounded-thread-pool concurrency path toWorkflowEngine._run_fan_out. That PR updatedengine.py,base.py, and tests, but the step's own class docstring was never updated, so it now contradicts the code.Fix
Update the docstring to match the engine's authoritative
_run_fan_outdocstring:Docstring-only change — no behavior change, no test needed.
ruff checkclean; import/docstring verified.AI-assisted: authored with Claude Code. I verified the claim against
WorkflowEngine._run_fan_outand commit 20f4306 (#3224).