From b3cf3032952a78d5e1b5d02d30885d6a293d2e3e Mon Sep 17 00:00:00 2001 From: Timon Date: Mon, 16 Dec 2019 10:13:35 -0600 Subject: [PATCH] Addes documentation to examples (#348) --- examples/README.md | 2 ++ examples/event-stream-async-std.rs | 2 +- examples/event-stream-tokio.rs | 2 +- examples/stderr.rs | 2 ++ 4 files changed, 6 insertions(+), 2 deletions(-) diff --git a/examples/README.md b/examples/README.md index 8626620..c278384 100644 --- a/examples/README.md +++ b/examples/README.md @@ -24,6 +24,8 @@ The examples are compatible with the latest release. $ cargo run --example [file name] ``` +To run the interactive-demo go into the folder `examples/interactive-demo` and run `cargo run`. + ## License This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details. diff --git a/examples/event-stream-async-std.rs b/examples/event-stream-async-std.rs index 31b37be..3c73bba 100644 --- a/examples/event-stream-async-std.rs +++ b/examples/event-stream-async-std.rs @@ -1,6 +1,6 @@ //! Demonstrates how to read events asynchronously with async-std. //! -//! cargo run --example event-read-char-line +//! cargo run --features="event-stream" --example event-stream-async-std use std::{ io::{stdout, Write}, diff --git a/examples/event-stream-tokio.rs b/examples/event-stream-tokio.rs index 25152fd..a5f67a4 100644 --- a/examples/event-stream-tokio.rs +++ b/examples/event-stream-tokio.rs @@ -1,6 +1,6 @@ //! Demonstrates how to read events asynchronously with tokio. //! -//! cargo run --features event-stream --example event-stream-tokio +//! cargo run --features="event-stream" --example event-stream-tokio use std::{ io::{stdout, Write}, diff --git a/examples/stderr.rs b/examples/stderr.rs index 87993c0..6b68188 100644 --- a/examples/stderr.rs +++ b/examples/stderr.rs @@ -5,6 +5,8 @@ //! //! This particular example is only suited to Unix //! for now. +//! +//! cargo run --example stderr use std::io::{stderr, Write};