Skip to content

feat: add --audit and --summary to diff_results.py - #1093

Merged
yakew7 merged 1 commit into
yakew7:mainfrom
minutechreview:feat/diff-results-audit-summary-1081
Oct 20, 2026
Merged

yakew7 merged 1 commit into
yakew7:mainfrom
minutechreview:feat/diff-results-audit-summary-1081

Conversation

@minutechreview

Copy link
Copy Markdown
Contributor

Summary

scripts/diff_results.py can now be limited to one or more audits and can print a one-line-per-audit summary, so a contributor who touched one audit does not have to scroll through 300+ rows.

Type

  • Audit
  • Explainer
  • Bug fix
  • Other

Details

  • --audit NAME (repeatable) filters both sides before the join. An audit name found on neither side exits 2 with unknown audit(s): ... (names are as in the CSVs, e.g. compas).
  • --summary prints, per kind and audit, rows compared, rows flagged and the largest absolute delta (n/a / null when no row has a numeric delta). With --json it prints the same as JSON.
  • Default output is unchanged. --fail-on-change still looks at every compared row.
  • SPEC section 11 and the README paragraph mention both options.

On the real data, --summary gives 7 lines per kind (for example compas: 90 compared, 69 flagged, largest |delta| 622.9074).

Checks: tests/test_diff_results.py 11 passed (4 new: audit filter and repeat, unknown audit, summary counts and text, summary with no numeric delta). ruff check, check_em_dash.py, check_broken_links.py and check_generated_files_current.py pass.

Linked issue

Fixes #1081

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

vercel Bot commented Oct 20, 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 @propcgamer20-png - new PR touching a path you own, please review.

@yakew7
yakew7 merged commit 4f95b4e into yakew7:main Oct 20, 2026
19 of 20 checks passed
yakew7 added a commit that referenced this pull request Oct 21, 2026
Add @Gauravbhati2099, bring @minutechreview and the dependabot count up
to date, and keep the Contributors section sorted by merged PRs, then
commits, then earliest first-merged date.
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.

diff_results.py prints 300+ lines by default; add --audit and a per-audit summary

2 participants