Skip to content

Conversation

danlaine
Copy link
Collaborator

@danlaine danlaine commented Jun 10, 2025

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.

@danlaine danlaine marked this pull request as ready for review June 10, 2025 20:21
@danlaine danlaine marked this pull request as draft June 10, 2025 20:27
@danlaine danlaine marked this pull request as ready for review June 10, 2025 21:46
BrendanChou
BrendanChou previously approved these changes Jun 11, 2025
@BrendanChou
Copy link
Collaborator

Unfortunately I don't know a good way for the linter to catch this...

use commonware_cryptography::PublicKey;

/// Configuration for the [`Engine`](super::Engine).
/// Configuration for the [Engine](super::Engine).
Copy link
Contributor

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?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done

Copy link
Contributor

@patrick-ogrady patrick-ogrady left a 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].
Copy link
Contributor

Choose a reason for hiding this comment

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

🙏

@patrick-ogrady patrick-ogrady merged commit bf35da2 into main Jun 16, 2025
17 checks passed
@patrick-ogrady patrick-ogrady deleted the danlaine/remove-ticks branch June 16, 2025 20:00
Copy link

codecov bot commented Jun 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.03%. Comparing base (31c895b) to head (06ba4e7).
Report is 3 commits behind head on main.

@@            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     
Files with missing lines Coverage Δ
broadcast/src/buffered/ingress.rs 76.38% <ø> (ø)
broadcast/src/buffered/metrics.rs 100.00% <ø> (ø)
broadcast/src/buffered/mod.rs 99.58% <ø> (ø)
codec/src/codec.rs 100.00% <ø> (ø)
codec/src/config.rs 100.00% <ø> (ø)
codec/src/extensions.rs 100.00% <ø> (ø)
codec/src/types/bytes.rs 100.00% <ø> (ø)
codec/src/types/map.rs 100.00% <ø> (ø)
codec/src/types/primitives.rs 99.55% <ø> (ø)
codec/src/types/set.rs 100.00% <ø> (ø)
... and 24 more

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c380cea...06ba4e7. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

3 participants