Repository navigation
docs: align v1 public API docs and examples - #44
Merged
Merged
Conversation
Finalization pass over the v1.2.0 public surface (no signature changes): - README: fix stale `version = "0.1"` install pins (3x) to "1.2". - ms_ssim/iw_ssim: replace broken `[module docs](self)` intra-doc links (private modules — warned under `cargo doc` and unreachable on docs.rs) with an inline scale-count note. - examples/compare + README quick-start: show all 9 metrics (add MS-SSIM, IW-SSIM, PSNR-HVS-M, CIEDE2000); widen the example's print column.
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.
Context
Finalization pass over the v1.2.0 public API surface. An audit found the surface to be structurally sound (uniform
Result<f64>returns, sharedError, consistent(reference, distorted, opts)order, sealed format traits,#![deny(missing_docs)]), with a few documentation/example drift items that contradict the "finalized v1" narrative. No public signatures change.Changes
iqa = { version = "0.1", ... }→"1.2"in all three install snippets (these predated the 1.0 release).[module docs](self)insrc/ms_ssim.rsandsrc/iw_ssim.rspointed at private modules: they warned undercargo docand were unreachable on docs.rs. Replaced with an inline scale-count sentence so the explanation survives in the rendered function docs.examples/compare.rsshowed only 5 of 9 metrics. Added MS-SSIM, IW-SSIM, PSNR-HVS-M, and CIEDE2000, updated the example'srequired-featuresinCargo.toml, and widened the example's print column to fit the longer labels.Known, intentionally-unchanged discrepancy
ciede2000(ref, dist, _opts: Ciede2000Options)takes an empty options struct whilessimulacra2(ref, dist)takes none — the one global inconsistency. Reconciling either way is a semver-major change, so it is deliberately left for a future 2.0.Verification
cargo doc(all metrics +vendored-lcms2): no warnings.cargo build --example comparewith all 9 metrics: compiles.cargo test --doc: all doctests pass (including thecompile_failtype-safety demos).