Skip to content

Commit

Permalink
Add documentation renamings
Browse files Browse the repository at this point in the history
  • Loading branch information
StemCll committed Jan 23, 2023
1 parent 763bfc8 commit 6e6445d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion protocols/gossipsub/src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ impl From<SigningError> for PublishError {

#[deprecated(
since = "0.44.0",
note = "Use re-exports that omit `Gossipsub` prefix, i.e. `libp2p::gossipsub::error::HandleError"
note = "Use re-exports that omit `Gossipsub` prefix, i.e. `libp2p::gossipsub::HandlerError"
)]
pub type GossipsubHandlerError = HandlerError;

Expand Down
18 changes: 9 additions & 9 deletions protocols/gossipsub/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -67,24 +67,24 @@
//!
//! # Using Gossipsub
//!
//! ## GossipsubConfig
//! ## Gossipsub Config
//!
//! The [`GossipsubConfig`] struct specifies various network performance/tuning configuration
//! The [`Config`] struct specifies various network performance/tuning configuration
//! parameters. Specifically it specifies:
//!
//! [`GossipsubConfig`]: struct.Config.html
//! [`Config`]: struct.Config.html
//!
//! This struct implements the [`Default`] trait and can be initialised via
//! [`GossipsubConfig::default()`].
//! [`Config::default()`].
//!
//!
//! ## Gossipsub
//! ## Behaviour
//!
//! The [`Gossipsub`] struct implements the [`libp2p_swarm::NetworkBehaviour`] trait allowing it to
//! The [`Behaviour`] struct implements the [`libp2p_swarm::NetworkBehaviour`] trait allowing it to
//! act as the routing behaviour in a [`libp2p_swarm::Swarm`]. This struct requires an instance of
//! [`libp2p_core::PeerId`] and [`GossipsubConfig`].
//! [`libp2p_core::PeerId`] and [`Config`].
//!
//! [`Gossipsub`]: struct.Gossipsub.html
//! [`Behaviour`]: struct.Behaviour.html
//! ## Example
//!
Expand Down Expand Up @@ -172,7 +172,7 @@ pub use self::error::{HandlerError, PublishError, SubscriptionError, ValidationE

#[deprecated(
since = "0.44.0",
note = "Use re-exports that omit `Gossipsub` prefix, i.e. `libp2p::gossipsub::error::HandleError"
note = "Use re-exports that omit `Gossipsub` prefix, i.e. `libp2p::gossipsub::HandlerError"
)]
pub type GossipsubHandlerError = HandlerError;

Expand Down

0 comments on commit 6e6445d

Please sign in to comment.