From 33b5c05529e1837796f4ea9bdd6a81a44a672f00 Mon Sep 17 00:00:00 2001 From: Hannes <55623006+umgefahren@users.noreply.github.com> Date: Wed, 5 Oct 2022 19:49:03 +0200 Subject: [PATCH] *: Updated comments in examples (#2985) --- examples/chat-tokio.rs | 10 +--------- examples/chat.rs | 4 ++-- examples/file-sharing.rs | 4 ++-- examples/gossipsub-chat.rs | 4 ++-- examples/ping.rs | 4 ++-- 5 files changed, 9 insertions(+), 17 deletions(-) diff --git a/examples/chat-tokio.rs b/examples/chat-tokio.rs index 8ad61ef8..72778e75 100644 --- a/examples/chat-tokio.rs +++ b/examples/chat-tokio.rs @@ -25,15 +25,7 @@ //! The example is run per node as follows: //! //! ```sh -//! cargo run --example chat-tokio --features="tcp-tokio mdns-tokio" -//! ``` -//! -//! Alternatively, to run with the minimal set of features and crates: -//! -//! ```sh -//!cargo run --example chat-tokio \\ -//! --no-default-features \\ -//! --features="floodsub mplex noise tcp-tokio mdns-tokio" +//! cargo run --example chat-tokio --features=full //! ``` use futures::StreamExt; diff --git a/examples/chat.rs b/examples/chat.rs index ee5527bf..082840ef 100644 --- a/examples/chat.rs +++ b/examples/chat.rs @@ -35,7 +35,7 @@ //! terminal window, run: //! //! ```sh -//! cargo run --example chat +//! cargo run --example chat --features=full //! ``` //! //! It will print the PeerId and the listening addresses, e.g. `Listening on @@ -44,7 +44,7 @@ //! In the second terminal window, start a new instance of the example with: //! //! ```sh -//! cargo run --example chat -- /ip4/127.0.0.1/tcp/24915 +//! cargo run --example chat --features=full -- /ip4/127.0.0.1/tcp/24915 //! ``` //! //! The two nodes then connect. diff --git a/examples/file-sharing.rs b/examples/file-sharing.rs index 21fa45d5..4e3cad3f 100644 --- a/examples/file-sharing.rs +++ b/examples/file-sharing.rs @@ -57,7 +57,7 @@ //! 1. Run command below in one terminal. //! //! ``` -//! cargo run --example file-sharing -- \ +//! cargo run --example file-sharing --features=full -- \ //! --listen-address /ip4/127.0.0.1/tcp/40837 \ //! --secret-key-seed 1 \ //! provide \ @@ -68,7 +68,7 @@ //! 2. Run command below in another terminal. //! //! ``` -//! cargo run --example file-sharing -- \ +//! cargo run --example file-sharing --features=full -- \ //! --peer /ip4/127.0.0.1/tcp/40837/p2p/12D3KooWPjceQrSwdWXPyLLeABRXmuqt69Rg3sBYbU1Nft9HyQ6X \ //! get \ //! --name diff --git a/examples/gossipsub-chat.rs b/examples/gossipsub-chat.rs index d6ea44dc..80720932 100644 --- a/examples/gossipsub-chat.rs +++ b/examples/gossipsub-chat.rs @@ -32,7 +32,7 @@ //! terminal window, run: //! //! ```sh -//! cargo run --example gossipsub-chat +//! cargo run --example gossipsub-chat --features=full //! ``` //! //! It will print the [`PeerId`] and the listening addresses, e.g. `Listening on @@ -41,7 +41,7 @@ //! In the second terminal window, start a new instance of the example with: //! //! ```sh -//! cargo run --example gossipsub-chat -- /ip4/127.0.0.1/tcp/24915 +//! cargo run --example gossipsub-chat --features=full -- /ip4/127.0.0.1/tcp/24915 //! ``` //! //! The two nodes should then connect. diff --git a/examples/ping.rs b/examples/ping.rs index 3919bfd4..9be23419 100644 --- a/examples/ping.rs +++ b/examples/ping.rs @@ -25,7 +25,7 @@ //! In the first terminal window, run: //! //! ```sh -//! cargo run --example ping +//! cargo run --example ping --features=full //! ``` //! //! It will print the PeerId and the listening addresses, e.g. `Listening on @@ -34,7 +34,7 @@ //! In the second terminal window, start a new instance of the example with: //! //! ```sh -//! cargo run --example ping -- /ip4/127.0.0.1/tcp/24915 +//! cargo run --example ping --features=full -- /ip4/127.0.0.1/tcp/24915 //! ``` //! //! The two nodes establish a connection, negotiate the ping protocol