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.

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

subscriber: fix incorrect formatter docs #1893

Merged
merged 3 commits into from
Feb 3, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions tracing-subscriber/src/fmt/format/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -301,13 +301,18 @@ pub struct FieldFnVisitor<'a, F> {
}
/// Marker for `Format` that indicates that the compact log format should be used.
///
/// The compact format only includes the fields from the most recently entered span.
/// The compact format includes fields from all currently entered spans, after
/// the event's fields. Span fields are not grouped by span, and span names are
/// not shown. In addition, a more compact representation of each event's
/// [`Level`](tracing::Level)
/// is used.
hawkw marked this conversation as resolved.
Show resolved Hide resolved
#[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
pub struct Compact;

/// Marker for `Format` that indicates that the verbose log format should be used.
/// Marker for `Format` that indicates that the default log format should be used.
///
/// The full format includes fields from all entered spans.
/// This format shows the span context before printing event data. Spans are
/// displayed including their names and fields.
#[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
pub struct Full;

Expand Down