Skip to content

Commit 49fddef

Browse files
committed
style: make structs/methods linkable in doc-strings
1 parent 2fb4ad9 commit 49fddef

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Diff for: src/common/buf.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use std::sync::atomic::{AtomicBool, Ordering};
33
use std::sync::Arc;
44
use tokio::sync::Notify;
55

6-
/// Signaler returned as part of `NotifyOnEos::new` that can be polled to receive information,
6+
/// Signaler returned as part of [`NotifyOnEos::new`] that can be polled to receive information,
77
/// when the buffer gets advanced to the end.
88
// Cannot be Clone due to usage of `Notify::notify_one` in `NotifyOnEos::advance`,
99
// revisit once `Notify::notify_all` stabilizes.
@@ -17,11 +17,11 @@ impl EosSignaler {
1717
}
1818
}
1919

20-
/// Wrapper for `bytes::Buf` that returns a `EosSignaler` that can be polled to receive information,
20+
/// Wrapper for [`Buf`] that returns an [`EosSignaler`] that can be polled to receive information,
2121
/// when the buffer gets advanced to the end.
2222
///
23-
/// NOTE: For the notification to work, caller must ensure that `Buf::advance` gets called
24-
/// enough times to advance to the end of the buffer (so that `Buf::has_remaining` afterwards returns `0`).
23+
/// NOTE: For the notification to work, caller must ensure that [`Buf::advance`] gets called
24+
/// enough times to advance to the end of the buffer (so that [`Buf::has_remaining`] afterwards returns `0`).
2525
pub struct NotifyOnEos<B> {
2626
inner: B,
2727
notifier: Arc<Notify>,

0 commit comments

Comments
 (0)