Skip to content

Commit

Permalink
Fix doc comment links
Browse files Browse the repository at this point in the history
  • Loading branch information
jtescher committed Feb 19, 2022
1 parent c585cd9 commit 31ca9ed
Show file tree
Hide file tree
Showing 8 changed files with 26 additions and 15 deletions.
3 changes: 1 addition & 2 deletions opentelemetry-api/src/baggage.rs
Expand Up @@ -6,10 +6,9 @@
//! information to metrics, traces, and logs.
//! * [`BaggageExt`]: Extensions for managing `Baggage` in a [`Context`].
//!
//! Baggage can be sent between systems using the [`BaggagePropagator`] in
//! Baggage can be sent between systems using a baggage propagator in
//! accordance with the [W3C Baggage] specification.
//!
//! [`BaggagePropagator`]: crate::sdk::propagation::BaggagePropagator
//! [W3C Baggage]: https://w3c.github.io/baggage
use crate::{Context, Key, KeyValue, Value};
use std::collections::{hash_map, HashMap};
Expand Down
6 changes: 2 additions & 4 deletions opentelemetry-api/src/global/mod.rs
Expand Up @@ -12,7 +12,7 @@
//!
//! ### Usage in Applications
//!
//! Applications configure their tracer either by [installing a trace pipeline],
//! Applications configure their tracer either by installing a trace pipeline,
//! or calling [`set_tracer_provider`].
//!
//! ```
Expand Down Expand Up @@ -68,7 +68,6 @@
//! # }
//! ```
//!
//! [installing a trace pipeline]: crate::sdk::export::trace::stdout::PipelineBuilder::install_simple
//! [`TracerProvider`]: crate::trace::TracerProvider
//! [`Span`]: crate::trace::Span
//!
Expand All @@ -84,7 +83,7 @@
//!
//! ### Usage in Applications
//!
//! Applications configure their meter either by [installing a metrics pipeline],
//! Applications configure their meter either by installing a metrics pipeline,
//! or calling [`set_meter_provider`].
//!
//! ```
Expand Down Expand Up @@ -135,7 +134,6 @@
//! # }
//! ```
//!
//! [installing a metrics pipeline]: crate::sdk::export::metrics::stdout::StdoutExporterBuilder::init
//! [`MeterProvider`]: crate::metrics::MeterProvider
//! [`set_meter_provider`]: crate::global::set_meter_provider

Expand Down
15 changes: 15 additions & 0 deletions opentelemetry-api/src/lib.rs
Expand Up @@ -3,9 +3,24 @@
//! can analyze them using [Prometheus], [Jaeger], and other observability tools.
//!
//! *Compiler support: [requires `rustc` 1.46+][msrv]*
//!
//! [Prometheus]: https://prometheus.io
//! [Jaeger]: https://www.jaegertracing.io
//! [msrv]: #supported-rust-versions
//!
//! ## Supported Rust Versions
//!
//! OpenTelemetry is built against the latest stable release. The minimum
//! supported version is 1.46. The current OpenTelemetry version is not
//! guaranteed to build on Rust versions earlier than the minimum supported
//! version.
//!
//! The current stable Rust compiler and the three most recent minor versions
//! before it will always be supported. For example, if the current stable
//! compiler version is 1.49, the minimum supported version will not be
//! increased past 1.46, three minor versions prior. Increasing the minimum
//! supported compiler version is not considered a semver breaking change as
//! long as doing so complies with this policy.
#![warn(
future_incompatible,
missing_debug_implementations,
Expand Down
3 changes: 1 addition & 2 deletions opentelemetry-api/src/trace/mod.rs
Expand Up @@ -53,11 +53,10 @@
//! Exporting spans often involves sending data over a network or performing
//! other I/O tasks. OpenTelemetry allows you to schedule these tasks using
//! whichever runtime you area already using such as [Tokio] or [async-std].
//! When using an async runtime it's best to use the [`BatchSpanProcessor`]
//! When using an async runtime it's best to use the batch span processor
//! where the spans will be sent in batches as opposed to being sent once ended,
//! which often ends up being more efficient.
//!
//! [`BatchSpanProcessor`]: crate::sdk::trace::BatchSpanProcessor
//! [Tokio]: https://tokio.rs
//! [async-std]: https://async.rs
//!
Expand Down
4 changes: 2 additions & 2 deletions opentelemetry-sdk/src/propagation/baggage.rs
Expand Up @@ -7,7 +7,7 @@
//! `Baggage`s are serialized according to the editor's draft of
//! the [W3C Baggage] specification.
//!
//! [`Baggage`]: crate::baggage::Baggage
//! [`Baggage`]: opentelemetry_api::baggage::Baggage
//! [W3C Baggage]: https://w3c.github.io/baggage/
//!
//! # Examples
Expand Down Expand Up @@ -96,7 +96,7 @@ lazy_static::lazy_static! {
/// ```
///
/// [W3C Baggage]: https://w3c.github.io/baggage
/// [`Baggage`]: crate::baggage::Baggage
/// [`Baggage`]: opentelemetry_api::baggage::Baggage
#[derive(Debug, Default)]
pub struct BaggagePropagator {
_private: (),
Expand Down
4 changes: 2 additions & 2 deletions opentelemetry-sdk/src/propagation/composite.rs
Expand Up @@ -12,7 +12,7 @@ use std::collections::HashSet;
/// Injection and extraction from this propagator will preserve the order of the
/// injectors and extractors passed in during initialization.
///
/// [`TextMapPropagator`]: crate::propagation::TextMapPropagator
/// [`TextMapPropagator`]: opentelemetry_api::propagation::TextMapPropagator
///
/// # Examples
///
Expand Down Expand Up @@ -67,7 +67,7 @@ pub struct TextMapCompositePropagator {
impl TextMapCompositePropagator {
/// Constructs a new propagator out of instances of [`TextMapPropagator`].
///
/// [`TextMapPropagator`]: crate::propagation::TextMapPropagator
/// [`TextMapPropagator`]: opentelemetry_api::propagation::TextMapPropagator
pub fn new(propagators: Vec<Box<dyn TextMapPropagator + Send + Sync>>) -> Self {
let mut fields = HashSet::new();
for propagator in &propagators {
Expand Down
2 changes: 1 addition & 1 deletion opentelemetry-sdk/src/testing/trace.rs
Expand Up @@ -130,7 +130,7 @@ impl<T> From<std::sync::mpsc::SendError<T>> for TestExportError {

/// A no-op instance of an [`SpanExporter`].
///
/// [`SpanExporter`]: crate::sdk::export::trace::SpanExporter
/// [`SpanExporter`]: crate::export::trace::SpanExporter
#[derive(Debug, Default)]
pub struct NoopSpanExporter {
_private: (),
Expand Down
4 changes: 2 additions & 2 deletions opentelemetry-sdk/src/trace/span_processor.rs
Expand Up @@ -31,8 +31,8 @@
//! +-----+--------------+ +---------------------+
//! ```
//!
//! [`is_recording`]: crate::trace::Span::is_recording()
//! [`TracerProvider`]: crate::trace::TracerProvider
//! [`is_recording`]: opentelemetry_api::trace::Span::is_recording()
//! [`TracerProvider`]: opentelemetry_api::trace::TracerProvider

use crate::export::trace::{ExportResult, SpanData, SpanExporter};
use crate::trace::runtime::{TraceRuntime, TrySend};
Expand Down

0 comments on commit 31ca9ed

Please sign in to comment.