Skip to content

Commit

Permalink
Fix broken link in CopyBufAbortable docs
Browse files Browse the repository at this point in the history
Also re-enable docs in CI.
  • Loading branch information
Jules-Bertholet committed Dec 12, 2023
1 parent 970e088 commit 850706a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
17 changes: 8 additions & 9 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion futures-util/src/io/copy_buf_abortable.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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> {
Expand Down

0 comments on commit 850706a

Please sign in to comment.