From c609a58086ca8c69d6ff14a80d56b0dba3976fb5 Mon Sep 17 00:00:00 2001 From: Wolfgang Bumiller Date: Wed, 2 Feb 2022 14:14:09 +0100 Subject: [PATCH] doc fixups Signed-off-by: Wolfgang Bumiller --- proxmox-http/src/client/rate_limited_stream.rs | 2 +- proxmox-http/src/client/rate_limiter.rs | 2 +- proxmox-metrics/src/influxdb/udp.rs | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/proxmox-http/src/client/rate_limited_stream.rs b/proxmox-http/src/client/rate_limited_stream.rs index 3a0eabd8..18355f5f 100644 --- a/proxmox-http/src/client/rate_limited_stream.rs +++ b/proxmox-http/src/client/rate_limited_stream.rs @@ -44,7 +44,7 @@ impl RateLimitedStream { Self::with_limiter(stream, Some(read_limiter), Some(write_limiter)) } - /// Creates a new instance with specified [RateLimiters] for reads and writes. + /// Creates a new instance with specified [`RateLimiter`s](RateLimiter) for reads and writes. pub fn with_limiter( stream: S, read_limiter: Option, diff --git a/proxmox-http/src/client/rate_limiter.rs b/proxmox-http/src/client/rate_limiter.rs index 05cded1e..4f6b790b 100644 --- a/proxmox-http/src/client/rate_limiter.rs +++ b/proxmox-http/src/client/rate_limiter.rs @@ -16,7 +16,7 @@ pub trait RateLimit { fn register_traffic(&mut self, current_time: Instant, data_len: u64) -> Duration; } -/// Like [RateLimit], but does not require self to be mutable. +/// Like [`RateLimit`], but does not require self to be mutable. /// /// This is useful for types providing internal mutability (Mutex). pub trait ShareableRateLimit: Send + Sync { diff --git a/proxmox-metrics/src/influxdb/udp.rs b/proxmox-metrics/src/influxdb/udp.rs index eb624b84..b73eb594 100644 --- a/proxmox-metrics/src/influxdb/udp.rs +++ b/proxmox-metrics/src/influxdb/udp.rs @@ -22,10 +22,10 @@ pub async fn test_influxdb_udp(address: &str) -> Result<(), Error> { Ok(()) } -/// Returns a [Metrics] handle that connects and sends data to the +/// Returns a [`Metrics`] handle that connects and sends data to the /// given influxdb server at the given udp address/port /// -/// `address` must be in the format of 'ip_or_hostname:port' +/// `address` must be in the format of `ip_or_hostname:port` pub fn influxdb_udp(address: &str, mtu: Option) -> Metrics { let (tx, rx) = mpsc::channel(1024);