From 850706aacaf1e8d5bdaf50a38bd424ad4e03b587 Mon Sep 17 00:00:00 2001 From: Jules Bertholet Date: Tue, 12 Dec 2023 16:48:50 -0500 Subject: [PATCH] Fix broken link in `CopyBufAbortable` docs Also re-enable docs in CI. --- .github/workflows/ci.yml | 17 ++++++++--------- futures-util/src/io/copy_buf_abortable.rs | 2 +- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dc6e573ba9..a12cb85826 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -281,12 +281,11 @@ jobs: run: rustup update stable - run: cargo fmt --all -- --check - # TODO: upstream bug https://github.com/rust-lang/rust/issues/118670 - # docs: - # name: cargo doc - # runs-on: ubuntu-latest - # steps: - # - uses: actions/checkout@v4 - # - name: Install Rust - # run: rustup update nightly && rustup default nightly - # - run: RUSTDOCFLAGS="-D warnings --cfg docsrs" cargo doc --workspace --no-deps --all-features + docs: + name: cargo doc + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Install Rust + run: rustup update nightly && rustup default nightly + - run: RUSTDOCFLAGS="-D warnings --cfg docsrs" cargo doc --workspace --no-deps --all-features diff --git a/futures-util/src/io/copy_buf_abortable.rs b/futures-util/src/io/copy_buf_abortable.rs index fdbc4a5f00..ed22d62338 100644 --- a/futures-util/src/io/copy_buf_abortable.rs +++ b/futures-util/src/io/copy_buf_abortable.rs @@ -57,7 +57,7 @@ where } pin_project! { - /// Future for the [`copy_buf()`] function. + /// Future for the [`copy_buf_abortable()`] function. #[derive(Debug)] #[must_use = "futures do nothing unless you `.await` or poll them"] pub struct CopyBufAbortable<'a, R, W: ?Sized> {