Document semver stability of crate features #949
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
Adds a column to the table in "Cargo features" documenting whether items gated behind each feature are exempt from Semver stability guarantees.
divergentdave
approved these changes
Feb 21, 2024
README.md
Outdated
| |`crypto-dependencies`|Yes|Enables dependencies on various RustCrypto crates, and uses them to implement `XofTurboShake128` to support VDAFs.|✅| | ||
| |`experimental`|No|Certain experimental APIs are guarded by this feature.|❌| | ||
| |`multithreaded`|No|Enables certain Prio3 VDAF implementations that use `rayon` for parallelization of gadget evaluations.|✅| | ||
| |`test-util`|No|Enables test utilities like [the `dummy::Vdaf`][dummy-vdaf].|❌| |
There was a problem hiding this comment.
It might be worth mentioning prio::vdaf::test_utils::run_vdaf() as well, for testing VDAFs outside the crate. Or we could say more generically, "Enables test utilities for VDAF users and VDAF implementers."
There was a problem hiding this comment.
Yeah, best not to commit to enumerating test-util items. I switched to your suggested sentence.
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.
Adds a column to the table in "Cargo features" documenting whether items gated behind each feature are exempt from Semver stability guarantees.