test: run doctests #17
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
|
sigilioso
approved these changes
May 15, 2025
| @@ -43,6 +43,7 @@ jobs: | |||
| rustup default ${{ matrix.toolchain }} | |||
| - run: cargo build --verbose | |||
| - run: cargo test --all-targets --verbose | |||
| - run: cargo test --doc | |||
There was a problem hiding this comment.
It seems that the line above doesn't run them automatically because of rust-lang/cargo#6669, good to know!
There was a problem hiding this comment.
Thanks for linking that issue! Wasn't aware it existed.
Added, thanks! |
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.
The pipelines for testing the project were calling
cargo test --all-targets --verbosewhich excludes doctests. This PR adds an additional line to run any existing doc tests and fixed some of the documented Rust code so it doesn't run since it wouldn't compile on its own.