Improve FromBytes documentation
#658
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
joshlf
requested changes
Nov 29, 2023
Member
|
Can you also mention #32 in the commit message? |
jswrenn
force-pushed
the
doc-frombytes
branch
from
846fba0 to
bd76510
Compare
joshlf
requested changes
Nov 30, 2023
jswrenn
force-pushed
the
doc-frombytes
branch
from
bd76510 to
13493f2
Compare
joshlf
previously approved these changes
Nov 30, 2023
Member
joshlf
left a comment
joshlf
left a comment
There was a problem hiding this comment.
Feel free to also bump the version number, and I can publish.
This PR adds examples to most methods of `FromBytes`, and separately documents `derive(FromBytes)`. Theoretical soundness requirements are placed with trait documentation, and the details of the derive's analysis is placed in the derive documentation. This PR follows the pattern of #505. Makes progress towards #32.
jswrenn
force-pushed
the
doc-frombytes
branch
from
13493f2 to
6958627
Compare
Collaborator
Author
|
Version bumped! |
joshlf
approved these changes
Nov 30, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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 adds examples to most methods of
FromBytes, and separately documentsderive(FromBytes). Theoretical soundness requirements are placed with trait documentation, and the details of the derive's analysis is placed in the derive documentation.This PR follows the pattern of #505.