Skip to content

chore: remove redundant and outdated comments - #1208

Open
isPANN wants to merge 4 commits into
mainfrom
chore/comment-cleanup
Open

isPANN wants to merge 4 commits into
mainfrom
chore/comment-cleanup

Conversation

@isPANN

@isPANN isPANN commented Oct 16, 2026 •

Copy link
Copy Markdown
Collaborator

Remove redundant code narration, obsolete drafting notes, and unrelated issue/PR provenance across the library, CLI, tests, scripts, and paper. Correct stale documentation that described permutation solutions as Lehmer codes.

Review all 465 canonical model and reduction example functions. Ordinary fixtures now omit duplicated input lists, witness walkthroughs, and expected-value commentary. Retain 14 brief comments explaining unusual construction choices, ordering dependencies, solver budgets, invariants, or mathematical lower bounds.

Fixture inputs, configurations, stored objectives, and executable behavior remain unchanged. The diff removes 1,685 net lines; incidental formatting includes removal of optional trailing commas. Remove an incomplete ignored macro syntax snippet that duplicated the attribute reference and failed when ignored doctests were enabled.

Validation:

  • make check (formatting, Clippy, workspace tests including ignored doctests and canonical-example validation)
  • make paper
  • node --check scripts/generate_reduction_graph_layout.js
  • Create the canonical MinimumCoveringByCliques example through pred, solve it independently with ILP, and verify the optimum is four.
  • Independent review confirms unchanged fixture data and behavior, with no findings.

The existing example database checks every stored model witness against its declared value and checks optimality where a registered solver is suitable for its test budget. This is not a claim that every stored optimum has independent solver certification.

@isPANN

isPANN commented Oct 16, 2026

Copy link
Copy Markdown
Collaborator Author

Agentic Review Report

Structural

Reviewed the generic maintenance diff now committed as 1c5ded92: 361 files, 128 insertions, and 1,130 deletions. The checkout matches the PR head and its working tree is clean. No generated exports are included.

A literal-aware comparison of the reviewed diff found identical noncomment token streams across all 359 changed Rust files, including raw string contents. The JavaScript and Typst changes affect comments only.

Quality

Updated solution representation and dimensions() documentation agrees with the evaluators, brute-force implementations, and registered decoders. Condensed mathematical explanations preserve the relevant constraints and identities. The removed macro documentation block is an incomplete ignored example; no executable implementation changed.

git diff --check passed during the independent review.

Feature test

No new model, reduction, or CLI behavior is introduced, so a new-feature CLI walkthrough is not applicable. This reviewer did not run builds, tests, or the CLI.

Separately, the parent agent reports that make check (formatting, Clippy with all features, and workspace tests including ignored tests and doctests) and make paper passed. GitHub CI was pending when the PR context was fetched.

Findings

  • Critical: None.
  • Important: None.
  • Minor: None.

Skipped reviewer builds, tests, and CLI execution as instructed; the independent verification above is static only.

@codecov

codecov Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.90%. Comparing base (f11b2a4) to head (cd7e66b).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1208      +/-   ##
==========================================
- Coverage   96.90%   96.90%   -0.01%     
==========================================
  Files        1095     1095              
  Lines      145109   144972     -137     
==========================================
- Hits       140621   140484     -137     
  Misses       4488     4488              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@isPANN

isPANN commented Oct 16, 2026

Copy link
Copy Markdown
Collaborator Author

Agentic Review Report

Incremental review of 1c5ded92..cd7e66b80831989a383f8ef1b97f5d41f858cc92 (199 files): the six-fixture cleanup and subsequent canonical model/rule fixture-comment sweep. The preceding PR implementation had already received an independent review and was not re-reviewed here.

Structural

No findings. Independently checked the incremental changes: fixture inputs, literals, configurations, stored objectives, and executable behavior are unchanged. The changes remove or condense comments and adjust formatting. Four files additionally lose optional trailing commas through rustfmt; those differences were inspected individually and are behavior-preserving.

Quality

No findings. Ordinary fixture commentary duplicating inputs, witnesses, and objective values was removed. Fresh extraction confirmed 14 concise comments remain to explain construction choices, representation constraints, invariants, or lower bounds. Checked the Tucker obstruction, the star's bandwidth lower bound, and the corrected strong-connectivity budget rationale against the actual fixtures. No comment-removal candidates occurred inside string data. No new tests are warranted for this behavior-preserving cleanup.

Feature test and verification

The parent agent ran the required gates on the final changes: make check && make paper passed. I inspected the saved logs: they confirm the check gate passed, including model_specs_are_self_consistent, model_specs_are_optimal, and rule_specs_solution_pairs_are_consistent, and the paper log reaches the Typst compilation step. The parent reports the paper command exited successfully.

The parent also exercised the real CLI: created the canonical MinimumCoveringByCliques instance using create --example, then solved it with --solver ilp. I inspected the resulting JSON: status is optimal, evaluation is Min(4), and solver.kind is ilp. This independently certifies the four-clique optimum rather than merely checking witness feasibility. The parent additionally reports its Node syntax check passed.

Severity-ranked findings

None.

Review was read-only; no builds were rerun by this reviewer. Verification execution is attributed above to the parent agent; runtime behavior is unchanged by this incremental diff.

This branch has not been deployed

No deployments
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.

1 participant