Skip to content

Commit

Permalink
Fix rustdoc warning
Browse files Browse the repository at this point in the history
```
warning: `crate::task::panic_waker` is both a module and a function
  --> futures-test/src/task/mod.rs:26:23
   |
26 | //! - [`panic_waker`](crate::task::panic_waker) creates a waker that panics when
   |                       ^^^^^^^^^^^^^^^^^^^^^^^^ ambiguous link
   |
   = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
help: to link to the module, prefix with `mod@`
   |
26 | //! - [`panic_waker`](mod@crate::task::panic_waker) creates a waker that panics when
   |                       ++++
help: to link to the function, add parentheses
   |
26 | //! - [`panic_waker`](crate::task::panic_waker()) creates a waker that panics when
   |                                               ++
```
  • Loading branch information
taiki-e committed Mar 30, 2023
1 parent 4b86e46 commit 890f893
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion futures-test/src/task/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
//! Test wakers:
//! - [`noop_waker`](crate::task::noop_waker) creates a waker that ignores calls to
//! [`wake`](futures_core::task::Waker).
//! - [`panic_waker`](crate::task::panic_waker) creates a waker that panics when
//! - [`panic_waker`](crate::task::panic_waker()) creates a waker that panics when
//! [`wake`](futures_core::task::Waker) is called.
//! - [`new_count_waker`](crate::task::new_count_waker) creates a waker that increments a counter whenever
//! [`wake`](futures_core::task::Waker) is called.
Expand Down

0 comments on commit 890f893

Please sign in to comment.