Skip to content

Commit 8fd86ba

Browse files
authored
docs(metrics): fix mpsc copy-paste doc errors (#20085)
1 parent e0a6f54 commit 8fd86ba

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

crates/metrics/src/common/mpsc.rs

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,13 @@ pub struct UnboundedMeteredSender<T> {
4242
}
4343

4444
impl<T> UnboundedMeteredSender<T> {
45-
/// Creates a new [`MeteredSender`] wrapping around the provided that updates metrics on send.
46-
// #[derive(Debug)]
45+
/// Creates a new [`UnboundedMeteredSender`] wrapping around the provided
46+
/// [`mpsc::UnboundedSender`] that updates metrics on send.
4747
pub fn new(sender: mpsc::UnboundedSender<T>, scope: &'static str) -> Self {
4848
Self { sender, metrics: MeteredSenderMetrics::new(scope) }
4949
}
5050

51-
/// Calls the underlying that updates metrics on send.
52-
// #[derive(Debug)]'s `try_send`, incrementing the appropriate
51+
/// Calls the underlying [`mpsc::UnboundedSender`]'s `send`, incrementing the appropriate
5352
/// metrics depending on the result.
5453
pub fn send(&self, message: T) -> Result<(), SendError<T>> {
5554
match self.sender.send(message) {
@@ -74,7 +73,7 @@ impl<T> Clone for UnboundedMeteredSender<T> {
7473
/// A wrapper type around [Receiver](mpsc::UnboundedReceiver) that updates metrics on receive.
7574
#[derive(Debug)]
7675
pub struct UnboundedMeteredReceiver<T> {
77-
/// The [Sender](mpsc::Sender) that this wraps around
76+
/// The [Receiver](mpsc::UnboundedReceiver) that this wraps around
7877
receiver: mpsc::UnboundedReceiver<T>,
7978
/// Holds metrics for this type
8079
metrics: MeteredReceiverMetrics,

0 commit comments

Comments
 (0)