Improve documentation and doctests #1741
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
|
Thanks! |
|
@sfackler Can I kindly ask you for a new release of the openssl crate? (I think openssl-sys is also needed due to changes in #1733). Thank you in advance! 🙏 (Context: #1733 (comment)) |
|
Done! |
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.
This PR aims to provide module descriptions for several modules as well as more elaborate examples for modules I've used.
In
openssl::hashI've moved the examples to functions that the example used (hashandhash_xof).I intentionally modified only the examples I touched and left the others alone (not to inflate the diffs).
It's a little bit challenging to come up with a example that is both short and works across all supported OpenSSL flavors. I hope this will provide a nice starting point for people new to the crate as it shows how to build more complex algorithms out of OpenSSL primitives.
Comments and suggestions welcome! Thanks in advance.