doc(kpm): rationale comments for kpm/freak too_many_arguments allows (#83) - #237
Merged
Conversation
…83) Second increment of the #83 cleanup, covering the kpm/freak layer. These functions keep their #[allow(clippy::too_many_arguments)] but now document why: - homography.rs: the numerical homography routines (4-point solvers, conditioning/denormalization, normal-equations, preemptive_robust and polish) — flat point/matrix/scalar signatures mirror the math and the C++ source; a param struct would obscure them. - hough.rs: HoughSimilarityVoting::new / new_auto_xy (mirror the C++ init parameter list) and find_hough_similarity. - ref_data_set.rs: KpmRefDataSet::generate. Left as-is (each already carries an explanatory rationale): the detector.rs module-level allow (34-fn extrema-extraction module; narrowing would be churn with no lint benefit) and the webarkit_cpp_* FFI extern shim. Audit doc updated. Comments only — no code or signatures changed. clippy --workspace --all-targets --all-features -D warnings clean. Refs #83 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
kalwalt
added
documentation
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
1 participant
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.
Second increment of #83, covering the
kpm/freaklayer. These functions keep their#[allow(clippy::too_many_arguments)]but now document why — completing the "reduce or justify" intent for this layer.Documented
homography.rs— the numerical homography routines: the 4-point solvers, conditioning/denormalization, normal-equations,preemptive_robust_homography,polish_homography. Flat point/matrix/scalar signatures mirror the math and the C++ source; a param struct would obscure them.hough.rs—HoughSimilarityVoting::new/new_auto_xy(mirror the C++initparameter list) andfind_hough_similarity.ref_data_set.rs—KpmRefDataSet::generate.Left as-is (already documented)
detector.rsmodule-level#![allow]— already carries theNONMAX_CHECKrationale, and it spans 34 functions; narrowing to per-fn would be churn with no lint benefit.webarkit_cpp_auto_adjust_xy_num_binsFFI extern shim (dual-mode test only).Audit doc (
docs/design/issue-83-too-many-args-audit.md) updated: every current allow is now either removed (PR #228) or carries a// rationale:note. The only remaining item is the optional pre-1.0 public-API restructure of the C-faithfular/ar2entry points — so #83 can be closed and that restructure tracked separately if wanted.Verification
Comments only — no code or signatures changed.
cargo fmt --checkclean;clippy --workspace --all-targets --all-features -D warningsclean (run locally withLIBCLANG_PATHset — the exact CI command).Refs #83
🤖 Generated with Claude Code