Improve the docs #160
Merged
Improve the docs #160
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
The example code is definitely meant to be cut'n pasted by users of the library. Add a CC-0 license so they are explicitly free to do so.
Recently we removed the two wrap examples in favour of a single one but forgot to update docs mentioning it.
54 tasks
Remove the stale comment and add an additional example call to get hex string.
Add an `# Errors` section to every public function that returns an error. Includes a couple of trait methods just for good measure. Enable the pedantic lint that lints for missing errors sections in rusdocs.
The `documentation` field of `package` section defaults to docsrs already, no need to explicitly state it.
As is typical round here we forgot to merge the latest 0.1 release notes back into master.
tcharding
force-pushed
the
02-21-docs
branch
from
0be2757 to
729f739
Compare
|
Shall we merge this one so it goes in the first alpha release? |
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.
Docs y'all. Done as part of #125.