Update docs for consistency #286
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
added 2 commits
November 9, 2023 18:29
tarcieri
approved these changes
Nov 13, 2023
|
I think there may be remaining places, but this is a start |
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 front of the repo explicitly states under Goals:
"Constant-time by default. Variable-time functions are explicitly marked as such."
Some constant-time functions in the repo are documented that they run in constant-time, while other constant-time functions do not. This inconsistency may lead a newcomer to question if a function is constant-time despite being explicitly chosen as such. This simple PR updates the docs on the functions in question to avoid confusion and remain consistent with the stated goals of the repo.