fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-06-12 17:41:22 +00:00
Code Issues Projects Releases Wiki Activity

.github/workflows: Deny cargo doc warnings in CI (#2936)

Browse Source 
Co-authored-by: Thomas Eizinger <thomas@eizinger.io>
This commit is contained in:
David D
2022-10-03 19:01:45 -06:00
committed by GitHub
parent a7a96e5502
commit e6da99e4f8
5 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
protocols/gossipsub/src/config.rs
View File

@ -267,7 +267,7 @@ impl GossipsubConfig {
/// connected/trusted nodes. The default is false.
///
/// Note: Peer exchange is not implemented today, see
/// https://github.com/libp2p/rust-libp2p/issues/2398.
/// <https://github.com/libp2p/rust-libp2p/issues/2398>.
pub fn do_px(&self) -> bool {
self.do_px
}
@ -334,7 +334,7 @@ impl GossipsubConfig {
/// Number of heartbeat ticks that specifcy the interval in which opportunistic grafting is
/// applied. Every `opportunistic_graft_ticks` we will attempt to select some high-scoring mesh
/// peers to replace lower-scoring ones, if the median score of our mesh peers falls below a
/// threshold (see https://godoc.org/github.com/libp2p/go-libp2p-pubsub#PeerScoreThresholds).
/// threshold (see <https://godoc.org/github.com/libp2p/go-libp2p-pubsub#PeerScoreThresholds>).
/// The default is 60.
pub fn opportunistic_graft_ticks(&self) -> u64 {
self.opportunistic_graft_ticks
@ -650,7 +650,7 @@ impl GossipsubConfigBuilder {
/// connected/trusted nodes. The default is false.
///
/// Note: Peer exchange is not implemented today, see
/// https://github.com/libp2p/rust-libp2p/issues/2398.
/// <https://github.com/libp2p/rust-libp2p/issues/2398>.
pub fn do_px(&mut self) -> &mut Self {
self.config.do_px = true;
self
@ -725,7 +725,7 @@ impl GossipsubConfigBuilder {
/// Number of heartbeat ticks that specifcy the interval in which opportunistic grafting is
/// applied. Every `opportunistic_graft_ticks` we will attempt to select some high-scoring mesh
/// peers to replace lower-scoring ones, if the median score of our mesh peers falls below a
/// threshold (see https://godoc.org/github.com/libp2p/go-libp2p-pubsub#PeerScoreThresholds).
/// threshold (see <https://godoc.org/github.com/libp2p/go-libp2p-pubsub#PeerScoreThresholds>).
/// The default is 60.
pub fn opportunistic_graft_ticks(&mut self, opportunistic_graft_ticks: u64) -> &mut Self {
self.config.opportunistic_graft_ticks = opportunistic_graft_ticks;

2
protocols/gossipsub/src/lib.rs
View File

@ -24,7 +24,7 @@
//! # Overview
//!
//! *Note: The gossipsub protocol specifications
//! (https://github.com/libp2p/specs/tree/master/pubsub/gossipsub) provide an outline for the
//! (<https://github.com/libp2p/specs/tree/master/pubsub/gossipsub>) provide an outline for the
//! routing protocol. They should be consulted for further detail.*
//!
//! Gossipsub is a blend of meshsub for data and randomsub for mesh metadata. It provides bounded