Skip to content

docs: document faircode benchmark --root and --no-plots (#1040) - #1054

Merged
yakew7 merged 1 commit into
yakew7:mainfrom
minutechreview:docs/benchmark-flags-1040
Oct 17, 2026
Merged

yakew7 merged 1 commit into
yakew7:mainfrom
minutechreview:docs/benchmark-flags-1040

Conversation

@minutechreview

Copy link
Copy Markdown
Contributor

Summary

faircode benchmark --root PATH and --no-plots only appeared in --help. This adds both to the README benchmark examples, with a short explanation under them:

  • --root PATH is the directory searched for */audit.yaml (one level down, default the current directory). It is ignored when manifest paths are passed, which matches run_benchmark in faircode/benchmark.py.
  • --no-plots skips figures/*.png, so matplotlib is not needed. The three CSV files are still written.

I also added the check the issue suggests, in tests/test_cli.py: every long option of every subcommand has to appear in the README or faircode/SPEC.md. It fails on the old README (benchmark --root, benchmark --no-plots) and passes now.

I put the text in the README only. SPEC.md has no benchmark command section today, and the new test accepts either file. Say so if you want a SPEC paragraph as well.

Type

  • Audit
  • Explainer
  • Bug fix
  • Other (docs and a test)

Linked issue

Closes #1040

Checks: pytest tests --ignore=tests/browser gives 817 passed, 21 skipped. ruff check faircode tests scripts, scripts/check_em_dash.py and scripts/check_broken_links.py pass. I did not run faircode benchmark itself (scikit-learn is not installed here); the descriptions come from the argument parser and run_benchmark, discover_manifests and write_report in the code.

Signed-off-by: minutechreview <141821420+minutechreview@users.noreply.github.com>
@vercel

vercel Bot commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

@minutechreview is attempting to deploy a commit to the yashkewlani2020-gmailcom's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions

Copy link
Copy Markdown

@yakew7 @Shreyash0712 @ahmdkaml - new PR touching a path you own, please review.

@yakew7
yakew7 merged commit 4538aa9 into yakew7:main Oct 17, 2026
19 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

faircode benchmark --root and --no-plots are not documented in the README or SPEC

2 participants