Fix failing doc tests #123
Merged
Conversation
This file contains 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.
Running
cargo testlocally results in failing doc tests.Turns out CI was not testing doc tests.
Its very silly but it seems that
cargo test --all-targetsskips running doc tests even thoughcargo testruns doc tests 🤦We already encountered this and fixed it in shotover https://github.com/shotover/shotover-proxy/blob/12ff17133952f643a128dbbb06ef3f87e4782cfd/.github/workflows/build_and_test.yaml#L66 but never did so in this project.
Since CI was not running doc tests, some doctest failures slipped through, so this PR fixes those failures.