Enable doctests to avoid coding mistakes in our API documentation #3557
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
In order to enable the tests, I had to fix a few tests, enhance tests
with hidden code, and mark a few as `no_run` instead of `rust`.
The tests marked as `no_run` will at least compile, but execution would
be stuck in an infinite loop, since we provide dummy implementation
to a lot of our intrinsics with `loop {}`.
Finally, as I was cleaning up the documentation, I noticed that we
accidently published an API that was meant to be internal to Kani.
I marked this API as deprecated for now.
Make it private already for `core`.
tautschnig
approved these changes
Oct 1, 2024
zhassan-aws
reviewed
Oct 1, 2024
zhassan-aws
approved these changes
Oct 2, 2024
Merged
via the queue into
model-checking:main
with commit Oct 2, 2024
68387e4
26 of 27 checks passed
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.
In order to enable the tests, I had to fix a few tests, enhance tests
with hidden code, and mark a few as
no_runinstead ofrust.The tests marked as
no_runwill at least compile, but we cannotexecute them otherwise execution would
be stuck in an infinite loop, since we provide dummy implementation
to a lot of our intrinsics with
loop {}.Finally, as I was cleaning up the documentation, I noticed that we
accidently published an API that was meant to be internal to Kani.
I marked this API as deprecated for now.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.