docs: warn that zero-valued Digest needs New/Reset - #87
Open
Solaris-star wants to merge 1 commit into
Open
Conversation
A zero Digest is a sharp edge when embedded in larger structs (cespare#65). Call out New/Reset in the README next to the Digest API. Fixes cespare#65
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
#65 notes that a zero-valued
Digestis not ready for writes (mustNew/Resetfirst), which is easy to miss when embeddingDigest.Fix
Document this sharp edge in the README next to the
DigestAPI.Fixes #65