-
Notifications
You must be signed in to change notification settings - Fork 111
[nit] remove unneeded ticks #1089
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
Conversation
Unfortunately I don't know a good way for the linter to catch this... |
broadcast/src/buffered/config.rs
Outdated
use commonware_cryptography::PublicKey; | ||
|
||
/// Configuration for the [`Engine`](super::Engine). | ||
/// Configuration for the [Engine](super::Engine). |
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.
I wonder if it is a good idea to use this opportunity to just use things directly?
i.e. switch to [super::Engine]
syntax?
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.
done
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.
(Will wait for another pass on crate::
and std::
)
//! The `Voter` caches all data required to participate in consensus to avoid any disk reads on | ||
//! on the critical path. To enable recovery, the `Voter` writes valid messages it receives from | ||
//! consensus and messages it generates to a write-ahead log (WAL) implemented by [Journal](https://docs.rs/commonware-storage/latest/commonware_storage/journal/index.html). | ||
//! consensus and messages it generates to a write-ahead log (WAL) implemented by [commonware_storage::journal::variable::Journal]. |
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.
🙏
Codecov ReportAll modified and coverable lines are covered by tests ✅
@@ Coverage Diff @@
## main #1089 +/- ##
==========================================
+ Coverage 91.01% 91.03% +0.02%
==========================================
Files 191 191
Lines 55217 55284 +67
==========================================
+ Hits 50253 50329 +76
+ Misses 4964 4955 -9
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
These ` don't do anything. We only need them sometimes in
//! Doc comments
when it thinks that the<T>
inside, e.g.Vec<T>
is an HTML tag.