Ignore README tests because they don't work in CI

This commit is contained in:
D. Scott Boggs 2023-01-24 15:14:41 -05:00 committed by Scott Boggs
parent 45338d5977
commit 184dd32146
1 changed files with 8 additions and 2 deletions

View File

@ -56,7 +56,13 @@ The `"mt"` feature is for tokio multi-threaded. For single threaded, drop the
`"mt"` feature and replace `#[tokio::main]` with `"mt"` feature and replace `#[tokio::main]` with
`#[tokio::main(flavor = "current_thread")]`. `#[tokio::main(flavor = "current_thread")]`.
```rust,no_run <!--
todo swap ignore with no_run just below here & the next example
test passes locally but not in CI
-->
```rust,ignore
// src/main.rs // src/main.rs
use mastodon_async::prelude::*; use mastodon_async::prelude::*;
@ -98,7 +104,7 @@ It also supports the [Streaming API](https://docs.joinmastodon.org/api/streaming
> [log_events](https://github.com/dscottboggs/mastodon-async/blob/main/examples/log_events.rs) > [log_events](https://github.com/dscottboggs/mastodon-async/blob/main/examples/log_events.rs)
> example for a more thorough example which does compile and run. > example for a more thorough example which does compile and run.
```rust,no_run ```rust,ignore
use mastodon_async::{prelude::*, Result, entities::event::Event}; use mastodon_async::{prelude::*, Result, entities::event::Event};
use futures_util::TryStreamExt; use futures_util::TryStreamExt;