diff --git a/tracing-core/src/dispatch.rs b/tracing-core/src/dispatch.rs index 70076a1480..bac9f64f08 100644 --- a/tracing-core/src/dispatch.rs +++ b/tracing-core/src/dispatch.rs @@ -118,9 +118,6 @@ //! // `my_collector` is now the default //! ``` //! -//!
//! @@ -241,9 +238,6 @@ pub struct DefaultGuard(Option); /// The default dispatcher is used when creating a new [span] or /// [`Event`]. /// -/// -//////ⓘNote-///////// Note: This function required the Rust standard library. @@ -269,9 +263,6 @@ pub fn with_default(dispatcher: &Dispatch, f: impl FnOnce() -> T) -> T { /// Sets the dispatch as the default dispatch for the duration of the lifetime /// of the returned DefaultGuard /// -/// -//////ⓘNote-///////// @@ -297,8 +288,6 @@ pub fn set_default(dispatcher: &Dispatch) -> DefaultGuard { /// Returns `Err` if the global default has already been set. /// /// -///-///⚠ ️Warning////// Warning: In general, libraries should not call ///set_global_default()
! Doing so will cause conflicts when @@ -734,9 +723,6 @@ impl Dispatch { /// This calls the [`drop_span`] function on the [`Collect`] that this /// `Dispatch` forwards to. /// - ///- //////⚠ ️Warning- ////// /// **Deprecated**: The [`try_close`] method is functionally identical, but returns `true` if the span is now closed. diff --git a/tracing-core/src/field.rs b/tracing-core/src/field.rs index 29d4709107..46db3900dc 100644 --- a/tracing-core/src/field.rs +++ b/tracing-core/src/field.rs @@ -166,9 +166,6 @@ pub struct Iter { /// `examples/counters.rs`, which demonstrates a very simple metrics system /// implemented using `tracing`. /// -///-//////ⓘNote-///////// Note: Therecord_error
trait method is only @@ -204,9 +201,6 @@ pub trait Visit { /// Records a type implementing `Error`. /// - ///- //////ⓘNote- ///////// Note: This is only enabled when the Rust standard library is @@ -631,9 +625,6 @@ impl FieldSet { /// Returns `true` if `self` contains the given `field`. /// - ///- //////ⓘNote- ///////// Note: Iffield
shares a name with a field diff --git a/tracing-core/src/metadata.rs b/tracing-core/src/metadata.rs index 5de3b1a2e4..c85327f524 100644 --- a/tracing-core/src/metadata.rs +++ b/tracing-core/src/metadata.rs @@ -33,9 +33,6 @@ use core::{ /// _significantly_ lower than that of creating the actual span. Therefore, /// filtering is based on metadata, rather than on the constructed span. /// -///-//////ⓘNote-///////// diff --git a/tracing-core/src/span.rs b/tracing-core/src/span.rs index 6cc97da9ab..be91fe2ac8 100644 --- a/tracing-core/src/span.rs +++ b/tracing-core/src/span.rs @@ -61,15 +61,12 @@ enum CurrentInner { impl Id { /// Constructs a new span ID from the given `u64`. /// - ///- //////ⓘNote- ///////// /// # Panics - /// - If the provided `u64` is 0 + /// - If the provided `u64` is 0. pub fn from_u64(u: u64) -> Self { Id(NonZeroU64::new(u).expect("span IDs must be > 0")) } diff --git a/tracing-subscriber/src/registry/mod.rs b/tracing-subscriber/src/registry/mod.rs index 484be5c788..01ecf92c71 100644 --- a/tracing-subscriber/src/registry/mod.rs +++ b/tracing-subscriber/src/registry/mod.rs @@ -88,9 +88,6 @@ pub trait LookupSpan<'a> { /// Returns the [`SpanData`] for a given [`Id`], if it exists. /// - ////// Note: Span IDs must be greater than zero.- //////ⓘNote- ///////// diff --git a/tracing-subscriber/src/subscribe.rs b/tracing-subscriber/src/subscribe.rs index a041125630..ff52730042 100644 --- a/tracing-subscriber/src/subscribe.rs +++ b/tracing-subscriber/src/subscribe.rs @@ -209,9 +209,6 @@ where /// By default, this returns [`Interest::always()`] if [`self.enabled`] returns /// true, or [`Interest::never()`] if it returns false. /// - ///- //////ⓘNote- ///////// @@ -253,9 +250,6 @@ where /// By default, this always returns `true`, allowing the wrapped collector /// to choose to disable the span. /// - ///- //////ⓘNote- ///////// @@ -998,9 +992,6 @@ where /// If this returns `None`, then no span exists for that ID (either it has /// closed or the ID is invalid). /// - ///- //////ⓘNote- ///////// @@ -1022,9 +1013,6 @@ where /// Returns `true` if an active span exists for the given `Id`. /// - ///- //////ⓘNote- ///////// @@ -1047,9 +1035,6 @@ where /// /// If this returns `None`, then we are not currently within a span. /// - ///- //////ⓘNote- ///////// @@ -1084,9 +1069,6 @@ where /// /// If this iterator is empty, then there are no spans in the current context. /// - ///- //////ⓘNote- ///////// diff --git a/tracing/src/dispatch.rs b/tracing/src/dispatch.rs index 8b3605536a..69aef9b528 100644 --- a/tracing/src/dispatch.rs +++ b/tracing/src/dispatch.rs @@ -118,9 +118,6 @@ //! //! // `my_collector` is now the default //! ``` -//!-//!//!ⓘNote-//!//!//! diff --git a/tracing/src/field.rs b/tracing/src/field.rs index f38276cce3..40937f01d4 100644 --- a/tracing/src/field.rs +++ b/tracing/src/field.rs @@ -5,9 +5,6 @@ use crate::Metadata; /// Trait implemented to allow a type to be used as a field key. /// -///-//////ⓘNote-///////// diff --git a/tracing/src/lib.rs b/tracing/src/lib.rs index 9870e320e7..a2296a676e 100644 --- a/tracing/src/lib.rs +++ b/tracing/src/lib.rs @@ -52,8 +52,6 @@ //! The [`span` module][mod@span]'s documentation provides further details on how to //! use spans. //! -//!-//!⚠ ️Warning//!//! //! **Warning**: In asynchronous code that uses async/await syntax, @@ -582,7 +580,6 @@ //! ``` //! //!-//!⚠ ️Warning//!//! Warning: In general, libraries should not call //!set_global_default()
! Doing so will cause conflicts when @@ -825,9 +822,6 @@ //! [`tracing-elastic-apm`]: https://crates.io/crates/tracing-elastic-apm //! [Elastic APM]: https://www.elastic.co/apm //! -//!-//!//!ⓘNote-//!//!//! Note: Some of these ecosystem crates are currently diff --git a/tracing/src/span.rs b/tracing/src/span.rs index d85030833e..dbaf0b69eb 100644 --- a/tracing/src/span.rs +++ b/tracing/src/span.rs @@ -76,8 +76,6 @@ //! // Dropping the `_enter` guard will exit the span. //!``` //! -//!-//!⚠ ️Warning//!//! //! **Warning**: In asynchronous code that uses async/await syntax, @@ -106,12 +104,9 @@ //! }); //! ``` //! -//!-//!//!ⓘNote-//!//!-//! Note: Since entering a span takes&self
Note: Since entering a span takes&self
, and //!Span
s areClone
,Send
, and //!Sync
, it is entirely valid for multiple threads to enter the //! same span concurrently. @@ -595,9 +590,6 @@ impl Span { /// will call [`Collect::exit`]. If the span is disabled, this does /// nothing. /// - ///- //////ⓘNote- ///////// @@ -612,9 +604,7 @@ impl Span { /// **Warning**: in asynchronous code that uses [async/await syntax][syntax], /// [`Span::enter`] should be used very carefully or avoided entirely. Holding /// the drop guard returned by `Span::enter` across `.await` points will - /// result in incorrect traces. - /// - /// For example, + /// result in incorrect traces. For example, /// /// ``` /// # use tracing::info_span; @@ -824,9 +814,6 @@ impl Span { /// Furthermore, `entered` may be used when the span must be stored in some /// other struct or be passed to a function while remaining entered. /// - ///- //////ⓘNote- ///////// @@ -1043,9 +1030,6 @@ impl Span { /// } /// ``` /// - ///- //////ⓘNote- /////////