Skip to content

Commit

Permalink
review: apply review suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
jxs committed Sep 28, 2022
1 parent b0da4d8 commit a91701e
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 11 deletions.
18 changes: 12 additions & 6 deletions protocols/identify/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@

- Update dependencies.

# 0.39.0

- Update to `libp2p-swarm` `v0.39.0`.

- Update to `libp2p-core` `v0.36.0`.

- Rename types as per [discussion 2174].
`Identify` has been renamed to `Behaviour`.
The `Identify` prefix has been removed from various types like `IdentifyEvent`.
Expand All @@ -16,6 +10,18 @@

[discussion 2174]: https://github.com/libp2p/rust-libp2p/discussions/2174

# 0.39.0

- Update to `libp2p-swarm` `v0.39.0`.

- Update to `libp2p-core` `v0.36.0`.

# 0.39.0

- Update to `libp2p-swarm` `v0.39.0`.

- Update to `libp2p-core` `v0.36.0`.

# 0.38.0

- Update prost requirement from 0.10 to 0.11 which no longer installs the protoc Protobuf compiler.
Expand Down
2 changes: 1 addition & 1 deletion protocols/identify/src/behaviour.rs
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ enum Reply {
},
}

/// Configuration for the [`Behaviour`] [`NetworkBehaviour`].
/// Configuration for the [`identify::Behaviour`](Behaviour).
#[non_exhaustive]
#[derive(Debug, Clone)]
pub struct Config {
Expand Down
8 changes: 4 additions & 4 deletions protocols/identify/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
//!
//! # Usage
//!
//! The [`Behaviour`] struct implements a `NetworkBehaviour` that negotiates
//! The [`Behaviour`] struct implements a [`NetworkBehaviour`] that negotiates
//! and executes the protocol on every established connection, emitting
//! [`Event`]s.
//!
Expand All @@ -48,18 +48,18 @@ pub use self::behaviour::{Behaviour, Config, Event};
pub use self::protocol::{Info, UpgradeError, PROTOCOL_NAME, PUSH_PROTOCOL_NAME};

#[deprecated(
since = "0.39.0",
since = "0.40.0",
note = "Use re-exports that omit `Identify` prefix, i.e. `libp2p::identify::Config`"
)]
pub type IdentifyConfig = Config;

#[deprecated(
since = "0.39.0",
since = "0.40.0",
note = "Use re-exports that omit `Identify` prefix, i.e. `libp2p::identify::Event`"
)]
pub type IdentifyEvent = Event;

#[deprecated(since = "0.39.0", note = "Use libp2p::identify::Behaviour instead.")]
#[deprecated(since = "0.40.0", note = "Use libp2p::identify::Behaviour instead.")]
pub type Identify = Behaviour;

mod behaviour;
Expand Down

0 comments on commit a91701e

Please sign in to comment.