Skip to content

Commit

Permalink
adjust docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xeniape committed Dec 19, 2024
1 parent 0e16812 commit be484ea
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion crates/stackable-telemetry/src/tracing/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@ impl TracingBuilder<builder_state::Config> {
}
}

/// Enable the OTLP logging subscriber and set the default [`LevelFilter`]
/// Enable the OTLP logging subscriber and set the default [`LevelFilter`][1]
/// which is overridable through the given environment variable.
///
/// You can configure the OTLP log exports through the variables defined
Expand Down
10 changes: 5 additions & 5 deletions crates/stackable-telemetry/src/tracing/settings/file_log.rs
Original file line number Diff line number Diff line change
Expand Up @@ -50,21 +50,21 @@ mod private {
/// This module holds the possible states that the builder is in.
///
/// Each state will implement [`BuilderState`] (with no methods), and the
/// Builder struct ([`TracingBuilder`]) itself will be implemented with
/// Builder struct ([`FileLogSettingsBuilder`][1]) itself will be implemented with
/// each state as a generic parameter.
/// This allows only the methods to be called when the builder is in the
/// applicable state.
///
/// [1]: FileLogSettingsBuilder
#[doc(hidden)]
pub mod builder_state {
/// The initial state, before the log directory path is set.
#[derive(Default)]
pub struct PreLogDir;

/// The state that allows you to configure the supported [`Subscriber`][1]
/// [`Layer`][2].
/// The state that allows you to configure the [`FileLogSettings`][1].
///
/// [1]: tracing::Subscriber
/// [2]: tracing_subscriber::layer::Layer
/// [1]: FileLogSettings
#[derive(Default)]
pub struct Config;
}
Expand Down

0 comments on commit be484ea

Please sign in to comment.