Skip to content
This repository has been archived by the owner on Oct 31, 2024. It is now read-only.

chore: adding doc to lib #342

Merged
merged 2 commits into from
Oct 19, 2023
Merged

chore: adding doc to lib #342

merged 2 commits into from
Oct 19, 2023

Conversation

Freyskeyd
Copy link
Member

Description

Adding some documentation about the topos-tce-broadcast crate

PR Checklist:

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added or updated tests that comprehensively prove my change is effective or that my feature works

Signed-off-by: Simon Paitrault <[email protected]>
@codecov
Copy link

codecov bot commented Oct 18, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (ef02f04) 60.73% compared to head (16cb576) 60.77%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #342      +/-   ##
==========================================
+ Coverage   60.73%   60.77%   +0.04%     
==========================================
  Files         232      232              
  Lines       12135    12133       -2     
==========================================
+ Hits         7370     7374       +4     
+ Misses       4765     4759       -6     
Files Coverage Δ
crates/topos-tce-broadcast/src/lib.rs 86.66% <ø> (+1.14%) ⬆️
crates/topos-tce-broadcast/src/sampler/mod.rs 100.00% <ø> (+12.50%) ⬆️

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@dvdplm dvdplm left a comment

Choose a reason for hiding this comment

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

Yes please!

Copy link
Member

@hadjiszs hadjiszs left a comment

Choose a reason for hiding this comment

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

also several occurrences of broadcasted where broadcast seems better.

crates/topos-tce-broadcast/src/lib.rs Outdated Show resolved Hide resolved
crates/topos-tce-broadcast/src/lib.rs Outdated Show resolved Hide resolved
crates/topos-tce-broadcast/src/lib.rs Outdated Show resolved Hide resolved
crates/topos-tce-broadcast/src/lib.rs Outdated Show resolved Hide resolved
crates/topos-tce-broadcast/src/lib.rs Outdated Show resolved Hide resolved
@Freyskeyd Freyskeyd merged commit 97686a7 into main Oct 19, 2023
16 checks passed
@Freyskeyd Freyskeyd deleted the doc/improve-broadcast-doc branch October 19, 2023 09:01
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants