Do trivial docs improvements #532
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
Make the module level docs uniform across the codebase (style copied from rust-bitcoin).
In docs "schnorr signature" does not need, or deserve, a capital letter.
Improve the rustdocs in the `schnorr` module by doing: - Use third person tense - Add full stops - Use links and code ticks
Improve the rustdocs in the `schnorr` module by doing: - Use third person tense - Add full stops - Use links and code ticks
apoelstra
approved these changes
Nov 24, 2022
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.
Audit of docs in
rust-secp256k1and do a few trivial fixes. The docs are in pretty good condition, they just need more content as described in #128 if that issue is still valid.