Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix broken doc links. #426

Merged
merged 2 commits into from Jan 3, 2022
Merged

Fix broken doc links. #426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
532fd8f
Fix broken doc links.
waywardmonkeys Dec 13, 2021
f671065
Merge branch 'master' into fix-broken-doc-links
lucab Jan 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/auto_flush.rs
View file
Open in desktop
Expand Up @@ -134,7 +134,7 @@ impl<T: 'static + MayFlush, D: HistogramDelegator<T>> AFLocalHistogram<T, D> {
}

impl<M: 'static + MayFlush, D: HistogramDelegator<M>> AFLocalHistogram<M, D> {
/// Add a single observation to the [`Histogram`](::Histogram).
/// Add a single observation to the [`Histogram`](crate::Histogram).
pub fn observe(&self, v: f64) {
self.delegator.get_root_metric().with(|m| {
let local = self.delegator.get_local(m);
Expand Down Expand Up @@ -175,7 +175,7 @@ impl<M: 'static + MayFlush, D: HistogramDelegator<M>> AFLocalHistogram<M, D> {
.with(|m| self.delegator.get_local(m).clear())
}

/// Flush the local metrics to the [`Histogram`](::Histogram) metric.
/// Flush the local metrics to the [`Histogram`](crate::Histogram) metric.
pub fn flush(&self) {
self.delegator
.get_root_metric()
Expand Down
44 changes: 22 additions & 22 deletions src/macros.rs
View file
Open in desktop
Expand Up @@ -47,7 +47,7 @@ fn test_labels_without_trailing_comma() {
assert_eq!(*(labels.get("test").unwrap()), "hello");
}

/// Create an [`Opts`].
/// Create an [`Opts`][crate::Opts].
///
/// # Examples
///
Expand Down Expand Up @@ -118,7 +118,7 @@ fn test_opts_trailing_comma() {
assert_eq!(opts.const_labels.get("ans").unwrap(), "42");
}

/// Create a [`HistogramOpts`].
/// Create a [`HistogramOpts`][crate::HistogramOpts].
///
/// # Examples
///
Expand Down Expand Up @@ -195,7 +195,7 @@ fn test_histogram_opts_trailing_comma() {
assert_eq!(opts.common_opts.const_labels.get("key").unwrap(), "value");
}

/// Create a [`Counter`] and registers to default registry.
/// Create a [`Counter`][crate::Counter] and registers to default registry.
///
/// # Examples
///
Expand Down Expand Up @@ -236,7 +236,7 @@ fn test_register_counter_trailing_comma() {
assert!(res2.is_ok());
}

/// Create a [`Counter`] and registers to a custom registry.
/// Create a [`Counter`][crate::Counter] and registers to a custom registry.
///
/// # Examples
///
Expand Down Expand Up @@ -288,7 +288,7 @@ fn test_register_counter_with_registry_trailing_comma() {
assert!(res2.is_ok());
}

/// Create an [`IntCounter`] and registers to default registry.
/// Create an [`IntCounter`][crate::IntCounter] and registers to default registry.
///
/// View docs of `register_counter` for examples.
#[macro_export(local_inner_macros)]
Expand All @@ -302,7 +302,7 @@ macro_rules! register_int_counter {
}};
}

/// Create an [`IntCounter`] and registers to a custom registry.
/// Create an [`IntCounter`][crate::IntCounter] and registers to a custom registry.
///
/// View docs of `register_counter_with_registry` for examples.
#[macro_export(local_inner_macros)]
Expand Down Expand Up @@ -372,7 +372,7 @@ macro_rules! __register_counter_vec {
}};
}

/// Create a [`CounterVec`] and registers to default registry.
/// Create a [`CounterVec`][crate::CounterVec] and registers to default registry.
///
/// # Examples
///
Expand Down Expand Up @@ -408,7 +408,7 @@ fn test_register_counter_vec_trailing_comma() {
assert!(counter_vec.is_ok());
}

/// Create a [`CounterVec`] and registers to a custom registry.
/// Create a [`CounterVec`][crate::CounterVec] and registers to a custom registry.
///
/// # Examples
///
Expand Down Expand Up @@ -462,7 +462,7 @@ fn test_register_counter_vec_with_registry_trailing_comma() {
assert!(counter_vec.is_ok());
}

/// Create an [`IntCounterVec`] and registers to default registry.
/// Create an [`IntCounterVec`][crate::IntCounterVec] and registers to default registry.
///
/// View docs of `register_counter_vec` for examples.
#[macro_export(local_inner_macros)]
Expand All @@ -476,7 +476,7 @@ macro_rules! register_int_counter_vec {
}};
}

/// Create an [`IntCounterVec`] and registers to a custom registry.
/// Create an [`IntCounterVec`][crate::IntCounterVec] and registers to a custom registry.
///
/// View docs of `register_counter_vec_with_registry` for examples.
#[macro_export(local_inner_macros)]
Expand Down Expand Up @@ -552,7 +552,7 @@ macro_rules! __register_gauge {
}};
}

/// Create a [`Gauge`] and registers to default registry.
/// Create a [`Gauge`][crate::Gauge] and registers to default registry.
///
/// # Examples
///
Expand Down Expand Up @@ -588,7 +588,7 @@ fn test_register_gauge_trailing_comma() {
assert!(res2.is_ok());
}

/// Create a [`Gauge`] and registers to a custom registry.
/// Create a [`Gauge`][crate::Gauge] and registers to a custom registry.
///
/// # Examples
///
Expand Down Expand Up @@ -637,7 +637,7 @@ fn test_register_gauge_with_registry_trailing_comma() {
assert!(res2.is_ok());
}

/// Create an [`IntGauge`] and registers to default registry.
/// Create an [`IntGauge`][crate::IntGauge] and registers to default registry.
///
/// View docs of `register_gauge` for examples.
#[macro_export(local_inner_macros)]
Expand All @@ -651,7 +651,7 @@ macro_rules! register_int_gauge {
}};
}

/// Create an [`IntGauge`] and registers to a custom registry.
/// Create an [`IntGauge`][crate::IntGauge] and registers to a custom registry.
///
/// View docs of `register_gauge_with_registry` for examples.
#[macro_export(local_inner_macros)]
Expand Down Expand Up @@ -719,7 +719,7 @@ fn test_register_int_gauge() {
assert!(res.is_ok());
}

/// Create a [`GaugeVec`] and registers to default registry.
/// Create a [`GaugeVec`][crate::GaugeVec] and registers to default registry.
///
/// # Examples
///
Expand Down Expand Up @@ -755,7 +755,7 @@ fn test_register_gauge_vec_trailing_comma() {
assert!(gauge_vec.is_ok());
}

/// Create a [`GaugeVec`] and registers to a custom registry.
/// Create a [`GaugeVec`][crate::GaugeVec] and registers to a custom registry.
///
/// # Examples
///
Expand Down Expand Up @@ -809,7 +809,7 @@ fn test_register_gauge_vec_with_registry_trailing_comma() {
assert!(gauge_vec.is_ok());
}

/// Create an [`IntGaugeVec`] and registers to default registry.
/// Create an [`IntGaugeVec`][crate::IntGaugeVec] and registers to default registry.
///
/// View docs of `register_gauge_vec` for examples.
#[macro_export(local_inner_macros)]
Expand All @@ -823,7 +823,7 @@ macro_rules! register_int_gauge_vec {
}};
}

/// Create an [`IntGaugeVec`] and registers to a custom registry.
/// Create an [`IntGaugeVec`][crate::IntGaugeVec] and registers to a custom registry.
///
/// View docs of `register_gauge_vec_with_registry` for examples.
#[macro_export(local_inner_macros)]
Expand Down Expand Up @@ -885,7 +885,7 @@ fn test_register_int_gauge_vec() {
assert!(res.is_ok());
}

/// Create a [`Histogram`] and registers to default registry.
/// Create a [`Histogram`][crate::Histogram] and registers to default registry.
///
/// # Examples
///
Expand Down Expand Up @@ -934,7 +934,7 @@ fn test_register_histogram_trailing_comma() {
assert!(res3.is_ok());
}

/// Create a [`Histogram`] and registers to a custom registry.
/// Create a [`Histogram`][crate::Histogram] and registers to a custom registry.
///
/// # Examples
///
Expand Down Expand Up @@ -1004,7 +1004,7 @@ fn test_register_histogram_with_registry_trailing_comma() {
assert!(res3.is_ok());
}

/// Create a [`HistogramVec`] and registers to default registry.
/// Create a [`HistogramVec`][crate::HistogramVec] and registers to default registry.
///
/// # Examples
///
Expand Down Expand Up @@ -1060,7 +1060,7 @@ fn test_register_histogram_vec_trailing_comma() {
assert!(histogram_vec.is_ok());
}

/// Create a [`HistogramVec`] and registers to default registry.
/// Create a [`HistogramVec`][crate::HistogramVec] and registers to default registry.
///
/// # Examples
///
Expand Down