Skip to content
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
merged 11 commits into from
Jul 21, 2023

Conversation

bkolad
Copy link
Member

@bkolad bkolad commented Jul 21, 2023

Description

sov-modules-stf-template crate compiles with the #![deny(missing_docs)] lint.

Linked Issues

Testing

No impact on tests.

Docs

Missing docs provided.

@codecov
Copy link

codecov bot commented Jul 21, 2023

Codecov Report

Merging #540 (06ddb1b) into nightly (fca041c) will decrease coverage by 0.1%.
The diff coverage is 100.0%.

Impacted Files Coverage Δ
...odule-system/sov-modules-stf-template/src/batch.rs 100.0% <ø> (+42.8%) ⬆️
...system/sov-modules-stf-template/src/tx_verifier.rs 100.0% <ø> (ø)
...ystem/sov-modules-stf-template/src/app_template.rs 82.7% <100.0%> (ø)
module-system/sov-modules-stf-template/src/lib.rs 97.4% <100.0%> (ø)

... and 14 files with indirect coverage changes

Copy link
Member

@neysofu neysofu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just small nitpicks:

  1. 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.
  2. I think it's best if we link to all relevant Rust types and items.
  3. doctest = false disables doc tests when running cargo test but not when running cargo test --doc, which is what people normally use when testing doctest changes. Instead, I'd suggest marking code examples in the README as rust,ignore and removing doctest = false.

bkolad and others added 4 commits July 21, 2023 12:41
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>
@bkolad bkolad merged commit 1ab2bc3 into nightly Jul 21, 2023
11 checks passed
@bkolad bkolad deleted the blaze/app_template_doc branch July 21, 2023 11:34
@citizen-stig citizen-stig linked an issue Jul 25, 2023 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cleanup: Add missing docs/tests to existing code
2 participants