Refactor equihash code
#1357
Merged
Refactor equihash code
#1357
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
str4d
force-pushed
the
equihash-refactor-code
branch
from
74f9aaa
to
d4b405f
Compare
arya2
approved these changes
Apr 19, 2024
| } | ||
|
|
||
| impl Params { | ||
| /// Returns `None` if the parameters are invalid. |
There was a problem hiding this comment.
Optional/Nitpick: Could the docs be more verbose, maybe with a reference to where and/or how the parameters are used?
Suggested change
| /// Returns `None` if the parameters are invalid. | |
| /// Accepts `n` and `k` values to use as Equihash parameters. | |
| /// | |
| /// Returns a new instance of [`Params`] if the provided values are valid, or | |
| /// `None` if the parameters are invalid. |
There was a problem hiding this comment.
The doc change here was just to clarify the change from Error (there is only one "error" case here, and Error is about verification errors, so I transitioned these to Option). I've opened #1358 for the general case of documenting the crate-private methods.
nuttycom
approved these changes
Apr 19, 2024
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.
Move-only; my main motivation is moving the minimal-encoding functions into a separate submodule, so that the inverse functions introduced in #1083 can also be placed there (with round-trip tests and proptests).