[code-improvement] documentation: align Ruff quality paths - #189
Merged
Pedro Henrique Penna (ppenna) merged 1 commit intoSep 22, 2026
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot started reviewing on behalf of
Pedro Henrique Penna (ppenna)
September 22, 2026 19:08
View session
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation now matches the quality action and references existing paths.
Review effort: Balanced
Findings: None
What changed in this PR
Aligns contributor Ruff commands with the repository’s authoritative quality checks.
Changes:
- Replaces nonexistent
benchmarkstargets with.github/specula. - Updates lint, format-check, and formatting commands consistently.
| File | Description |
|---|---|
doc/setup.md |
Corrects documented Ruff target paths. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Pedro Henrique Penna (ppenna)
marked this pull request as ready for review
September 22, 2026 20:29
Pedro Henrique Penna (ppenna)
deleted the
code-improvement/document-ruff-paths-35769298647-dd5a37902d5f9e2f
branch
September 22, 2026 20:39
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.
Scope
Named category:
documentationdoc/setup.mdtold contributors to run Ruff againstbenchmarks, but that path does not exist. The authoritative quality action targetsscriptsand.github/specula, and both Specula Python files are present, so this aligns all three documented Ruff commands with the repository-defined check.The current
devCI failure was not selected:OpenVMM vmm-tests / Linux / MSHVtimed out in the private OpenVMM test suite and cannot be reproduced or fixed in an allowed NVX file without MSHV hardware. Category weighting therefore selected documentation (weight 4).Live searches found no open issue or pull request changing
doc/setup.mdor proposing this Ruff-path correction. All 14 recent code-improvement pull requests were merged, with noCHANGES_REQUESTEDreview or maintainer rejection of this candidate.Change
doc/setup.md: replace the nonexistentbenchmarksRuff target with.github/speculain the check, format-check, and formatter commands.Validation
test ! -e benchmarks && test -f .github/specula/ci.py && test -f .github/specula/tests/test_ci.py— passed.python3 -m ruff check scripts .github/specula— passed.python3 -m ruff format --check scripts .github/specula— passed; 34 files already formatted.python3 -m ruff format scripts .github/specula— passed; 34 files unchanged.git diff --check— passed.git diff --numstat—3 3 doc/setup.md.git diff --raw— one regular-file modification; no160000entry.No dependency, public API/CLI/ABI, gitlink, or OpenVMM change was made.