From ac1c0bf8fb4d1a30306b2ad739f4cb70d08df7b0 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Wed, 12 Oct 2022 14:14:17 +0100 Subject: [PATCH] README doctests: fix arti-client Add ,ignore to ignore three examples that don't actually compile. cargo readme would add these annotations to lib.rs, but the doc include doesn't do stuff like that. pandoc seems to still render the result just fine. --- crates/arti-client/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/crates/arti-client/README.md b/crates/arti-client/README.md index 0b4326bdf..7c122a198 100644 --- a/crates/arti-client/README.md +++ b/crates/arti-client/README.md @@ -53,7 +53,7 @@ This state gets persisted to the locations specified in the (This method requires you to initialize the client in an `async fn`. Consider using the builder method, below, if that doesn't work for you.) -```rust +```rust,ignore // The client configuration describes how to connect to the Tor network, // and what directories to use for storing persistent state. let config = TorClientConfig::default(); @@ -74,7 +74,7 @@ bootstrap (or having to use an `await`). This can be done by making a The returned client can be made to bootstrap when it is first used (the default), or not; see [`BootstrapBehavior`] for more details. -```rust +```rust,ignore // Specifying `BootstrapBehavior::OnDemand` means the client will automatically // bootstrap when it is used. `Manual` exists if you'd rather have full control. let tor_client = TorClient::builder() @@ -93,7 +93,7 @@ those traits if the `tokio` crate feature is enabled. ### Example: making connections over Tor -```rust +```rust,ignore # // Initiate a connection over Tor to example.com, port 80. let mut stream = tor_client.connect(("example.com", 80)).await?;