Skip to content

docs: clarify parallel execution vs scenario generation - #2656

Merged
kevinmessiaen merged 5 commits into
mainfrom
docs/clarify-parallel-execution
Aug 3, 2026
Merged

docs: clarify parallel execution vs scenario generation#2656
kevinmessiaen merged 5 commits into
mainfrom
docs/clarify-parallel-execution

Conversation

@davidberenstein1957

Copy link
Copy Markdown
Member

Summary

  • Clarifies that parallel controls suite execution against the target, not scenario generation
  • Documents defaults: Suite.run serial (False), scan helpers parallel (True), generate_suite always concurrent
  • Notes that max_concurrency is ignored when parallel=False
  • Adds existing pyright: ignore[reportInvalidTypeForm] for MISSING sentinel annotations in suite.py (same pattern as runner.py) so the file can pass pre-commit

Closes #2655

Test plan

  • Skim docstring changes in Suite.run, ScanOptions, quality_scan, generate_suite
  • Confirm no runtime / API behavior changes

Make Suite.run, scan options, and generate_suite docs distinguish
always-concurrent generation from opt-in suite execution parallelism.
CI installs latest ruff via uv tool, which formats Markdown fenced
code blocks; align those files so check-format passes.
Keep main's README quickstart updates from #2674; PR only had
whitespace formatting in that file.

Co-authored-by: Kevin Messiaen <kevinmessiaen@users.noreply.github.com>
Valid values do not affect serial scheduling, but invalid values are
still rejected before the parallel/serial branch.

Co-authored-by: Kevin Messiaen <kevinmessiaen@users.noreply.github.com>
basedpyright no longer reports reportInvalidTypeForm for Target|MISSING
annotations; the ignores were flagged as unused.

Co-authored-by: Kevin Messiaen <kevinmessiaen@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

docs: clarify parallel execution vs scenario generation

3 participants