Don't let doctest quirks stop testing in release mode #60
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
Nashtare
approved these changes
Feb 26, 2024
There was a problem hiding this comment.
This is fine to me. However, the issue was coming from starky hiding behind a conditional debug_assertions flag the module to be imported here, which is what was messing up doctest runs.
As starky v.0.2.1 would expose this module regardless, there are technically no changes needed here to make it work. So I'm not sure we should bother (although having the imports within the conditionally evaluated brackets seems cleaner to me).
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.
On
mainwe can't run tests with a simplecargo t --releasebecause of a quirk in the way doctests are compiled in Rust. Doctests do not "see" compilation attributes like e.g.test,doctestor, as is the case here,debug_assertionsbecause they are treated as separate compilation units.To work around this, this PR moves the relevant
useclauses to the one spot in the code where thedebug_utilsmodules are actually used and removes the conditional compilation from the modules themselves. The same has to be done instarkyand that must be merged and published before this PR can be merged.Depends on 0xPolygonZero/plonky2#1540 being merged and published.