Make crate-level doc example compile-tested (0.1.1) - #2
Merged
Conversation
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
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.
Converts the crate-level doc example from
ignoreto a compile-tested doctest, so docs.rs no longer shows the "This example is not tested" note and the example is verified on every build.Changes
src/lib.rs: crate-level example is now a real doctest —pubstructs + a hiddenmain/async wrapper to satisfy the private-in-public rule (E0446) on stable rustc0.1.0→0.1.1CHANGELOG.md: 0.1.1 entryVerification (on stable rustc 1.97.1, matching CI)
cargo fmt --check— cleancargo clippy --all-targets -- -D warnings— cleancargo test— 19 tests pass; doctests: 1 passed, 2 ignored (the 2 remaining are on private internal types, not shown on docs.rs)cargo publish --dry-run— packages + verifiesThe 2 still-ignored doctests are partial DSL-grammar snippets on private
inputtypes (ApiClientInput,EndpointDef); they don't render on the public docs page, so no badge.