Tightens lint policy, documents API, and hardens runtime paths - #222
Merged
Conversation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why
Adopting a more opinionated lint configuration surfaces latent defects,
encourages defensive coding, and provides users with better‐documented
APIs. The patch adds the missing documentation and refactors panic-prone
code so the project builds cleanly with the newly denied lints.
What
clippy::*groups,missing_docs, andmissing_crate_level_docs.expectonlyinside tests.
ir/,manifest/) to attach crate-leveldocs.
unwrap/expectin production code withfallible paths and rich error messages; keeps them in tests behind an
explicit allowance.
(e.g. string conversions, thread joins, HTTP fixtures).
eprintln!totracingfor structured logging.previously undocumented.
Outcome
The crate now builds with
cargo clippy --all-targets -- -D warnings,has a clearer public surface, and is less prone to runtime panics or
invalid UTF-8 issues while preserving existing behaviour in tests and
features.