From ce6c4036802efed69e5dceda40a4648dc50f2441 Mon Sep 17 00:00:00 2001 From: Eliza Weisman Date: Fri, 19 Nov 2021 14:34:18 -0800 Subject: [PATCH] subscriber: "implementing FormatEvent" docs (#1727) This branch adds some documentation to the `FormatEvent` trait in `tracing_subscriber::fmt` on how to write user-provided `FormatEvent` implementations. There's probably room for additional improvement here, but I just wanted to get something written down for now. I also fixed a broken link I noticed while I was here. Signed-off-by: Eliza Weisman Co-authored-by: David Barsky --- tracing-subscriber/src/fmt/format/mod.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tracing-subscriber/src/fmt/format/mod.rs b/tracing-subscriber/src/fmt/format/mod.rs index 5d5d36981d..edae251025 100644 --- a/tracing-subscriber/src/fmt/format/mod.rs +++ b/tracing-subscriber/src/fmt/format/mod.rs @@ -155,7 +155,7 @@ pub use pretty::*; /// /// [`fmt::Layer`]: super::Layer /// [`fmt::Subscriber`]: super::Subscriber -/// [`layer::Context`]: crate::layer::Context +/// [`Event`]: tracing::Event /// [implements `FormatFields`]: super::FmtContext#impl-FormatFields<'writer> /// [ANSI terminal escape codes]: https://en.wikipedia.org/wiki/ANSI_escape_code /// [`Writer::has_ansi_escapes`]: Writer::has_ansi_escapes