Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Dav1dde committed Nov 10, 2023
1 parent 640775e commit 3a01dde
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
2 changes: 1 addition & 1 deletion relay-config/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -989,7 +989,7 @@ pub struct Processing {
/// The approximate maximum number of bytes submitted in one metrics batch for processing
/// relays.
///
/// Overrides [`metrics_max_batch_size`] when specified on processing relays.
/// Overrides [`Self::metrics_max_batch_size`] when specified on processing relays.
#[serde(default)]
pub metrics_max_batch_size_processing: Option<ByteSize>,
}
Expand Down
12 changes: 5 additions & 7 deletions relay-metrics/src/view.rs
Original file line number Diff line number Diff line change
Expand Up @@ -304,25 +304,23 @@ impl<'a> BucketView<'a> {
}
}

// TODO: make sure `See Also` links actually work

/// Timestamp of the bucket.
///
/// See also: [`Bucket.timestamp`]
/// See also: [`Bucket::timestamp`]
pub fn timestamp(&self) -> UnixTimestamp {
self.inner.timestamp
}

/// Width of the bucket.
///
/// See also: [`Bucket.width`]
/// See also: [`Bucket::width`]
pub fn width(&self) -> u64 {
self.inner.width
}

/// Name of the bucket.
///
/// See also: [`Bucket.name`]
/// See also: [`Bucket::name`]
pub fn name(&self) -> &str {
&self.inner.name
}
Expand All @@ -339,14 +337,14 @@ impl<'a> BucketView<'a> {

/// Name of the bucket.
///
/// See also: [`Bucket.tags`]
/// See also: [`Bucket::tags`]
pub fn tags(&self) -> &BTreeMap<String, String> {
&self.inner.tags
}

/// Returns the value of the specified tag if it exists.
///
/// See also: [`Bucket::tag`]
/// See also: [`Bucket::tag()`]
pub fn tag(&self, name: &str) -> Option<&str> {
self.inner.tag(name)
}
Expand Down

0 comments on commit 3a01dde

Please sign in to comment.