Improve documentation and add examples #3
Merged
Conversation
This file contains hidden or 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
| /// which returns a `(u64, u64)` pair for greater precision. | ||
| /// | ||
| /// </div> | ||
| fn finish(&self) -> u64 { |
Member
There was a problem hiding this comment.
Does deprecated work on implementations? If so, you could add it here.
Member
Author
There was a problem hiding this comment.
Unfortunately no,
error: this `#[deprecated]` annotation has no effect
--> src/stable_hasher.rs:118:5
|
118 | #[deprecated = "use StableHasher::finalize instead"]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: remove the unnecessary deprecation attribute
|
= note: `#[deny(useless_deprecated)]` on by default
error: could not compile `rustc-stable-hash` (lib) due to 1 previous error
Member
There was a problem hiding this comment.
Afaik, the panic is from a time when there was no StableHashResult yet. It should be fine to just return one half of the hash or do something like Fingerprint::combine.
Member
Author
|
#4 was merged, I have rebased this PR over @WaffleLapkin @michaelwoerister any objections? |
Member
|
@Urgau, I left a couple of remarks but nothing blocking. I'm good with merging the PR, looks great! |
WaffleLapkin
approved these changes
Jun 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This PR improves the documentation of the public methods of
StableHasherand adds some usage examples.cc @weihanglo
r? @WaffleLapkin
Fixes #2