Skip to content

Commit

Permalink
*: Updated comments in examples (#2985)
Browse files Browse the repository at this point in the history
  • Loading branch information
umgefahren committed Oct 5, 2022
1 parent bdf9209 commit 33b5c05
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 17 deletions.
10 changes: 1 addition & 9 deletions examples/chat-tokio.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
4 changes: 2 additions & 2 deletions examples/chat.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions examples/file-sharing.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand All @@ -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 <name-for-others-to-find-your-file>
Expand Down
4 changes: 2 additions & 2 deletions examples/gossipsub-chat.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions examples/ping.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 33b5c05

Please sign in to comment.