-
Notifications
You must be signed in to change notification settings - Fork 105
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add missing doc for the sov-modules-stf-template
crate.
#540
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
Codecov Report
|
neysofu
requested changes
Jul 21, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just small nitpicks:
- The first paragraph of the doc comment is the one shown when looking at the module overview; it should be concise and it's established practice to skip the subject if necessary e.g. "This
enum
is...". We can be more verbose from the second paragraph onwards. - I think it's best if we link to all relevant Rust types and items.
doctest = false
disables doc tests when runningcargo test
but not when runningcargo test --doc
, which is what people normally use when testing doctest changes. Instead, I'd suggest marking code examples in the README asrust,ignore
and removingdoctest = false
.
neysofu
reviewed
Jul 21, 2023
Co-authored-by: Filippo Neysofu Costa <filippo@sovlabs.io>
Co-authored-by: Filippo Neysofu Costa <filippo@sovlabs.io>
Co-authored-by: Filippo Neysofu Costa <filippo@sovlabs.io>
neysofu
approved these changes
Jul 21, 2023
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.
Description
sov-modules-stf-template
crate compiles with the#![deny(missing_docs)]
lint.Linked Issues
Testing
No impact on tests.
Docs
Missing docs provided.