From 898ad1aa37bb94428985c627fd5b0428c34ef8b4 Mon Sep 17 00:00:00 2001 From: David Barsky Date: Sat, 12 Jun 2021 19:37:59 -0400 Subject: [PATCH] docs: Fix rendering issue with misaligned tooltips. --- tracing-core/src/dispatcher.rs | 14 -------------- tracing-core/src/field.rs | 9 --------- tracing-core/src/metadata.rs | 3 --- tracing-core/src/span.rs | 5 +---- tracing-subscriber/src/layer.rs | 18 ------------------ tracing-subscriber/src/registry/mod.rs | 3 --- tracing/src/dispatcher.rs | 3 --- tracing/src/field.rs | 3 --- tracing/src/lib.rs | 6 ------ tracing/src/span.rs | 17 ++--------------- 10 files changed, 3 insertions(+), 78 deletions(-) diff --git a/tracing-core/src/dispatcher.rs b/tracing-core/src/dispatcher.rs index 9fb7e73b2c..d1ff5eb757 100644 --- a/tracing-core/src/dispatcher.rs +++ b/tracing-core/src/dispatcher.rs @@ -108,9 +108,6 @@ //! // `my_subscriber` is now the default //! ``` //! -//!
-//!
ⓘNote
-//!
//!
//! 
 //! Note:the thread-local scoped dispatcher
@@ -211,9 +208,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.
@@ -239,9 +233,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

-/// 

 /// 

 /// 
 /// Note: This function required the Rust standard library.
@@ -268,8 +259,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
@@ -585,9 +574,6 @@ impl Dispatch {
     /// This calls the [`drop_span`] function on the [`Subscriber`] 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 e3c2f5782b..e2eb7f14eb 100644
--- a/tracing-core/src/field.rs
+++ b/tracing-core/src/field.rs
@@ -169,9 +169,6 @@ pub struct Iter {
 /// `examples/counters.rs`, which demonstrates a very simple metrics system
 /// implemented using `tracing`.
 ///
-/// 

-///     
ⓘNote

-/// 

 /// 

 /// 
 /// Note: The record_error trait method is only
@@ -209,9 +206,6 @@ pub trait Visit {
 
     /// Records a type implementing `Error`.
     ///
-    /// 

-    ///     
ⓘNote

-    /// 

     /// 

     /// 
     /// Note: This is only enabled when the Rust standard library is
@@ -636,9 +630,6 @@ impl FieldSet {
 
     /// Returns `true` if `self` contains the given `field`.
     ///
-    /// 

-    ///     
ⓘNote

-    /// 

     /// 

     /// 
     /// Note: If field shares a name with a field
diff --git a/tracing-core/src/metadata.rs b/tracing-core/src/metadata.rs
index ee6a1f13df..91c23a41e9 100644
--- a/tracing-core/src/metadata.rs
+++ b/tracing-core/src/metadata.rs
@@ -33,9 +33,6 @@ use crate::stdlib::{
 /// _significantly_ lower than that of creating the actual span. Therefore,
 /// filtering is based on metadata, rather than on the constructed span.
 ///
-/// 

-///     
ⓘNote

-/// 

 /// 

 /// 
 /// Note: Although instances of Metadata cannot
diff --git a/tracing-core/src/span.rs b/tracing-core/src/span.rs
index 8f5b6101f6..238c251219 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

-    /// 

     /// 

     /// 
     /// Note: Span IDs must be greater than zero.

     ///
     /// # 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/layer.rs b/tracing-subscriber/src/layer.rs
index ffdd89c10c..e4322e24a4 100644
--- a/tracing-subscriber/src/layer.rs
+++ b/tracing-subscriber/src/layer.rs
@@ -212,9 +212,6 @@ where
     /// By default, this returns [`Interest::always()`] if [`self.enabled`] returns
     /// true, or [`Interest::never()`] if it returns false.
     ///
-    /// 

-    ///     
ⓘNote

-    /// 

     /// 

     /// 
     /// Note: This method (and 
@@ -264,9 +261,6 @@ where
     /// By default, this always returns `true`, allowing the wrapped subscriber
     /// to choose to disable the span.
     ///
-    /// 

-    ///     
ⓘNote

-    /// 

     /// 

     /// 
     /// Note: This method (and 
@@ -1014,9 +1008,6 @@ where
     /// If this returns `None`, then no span exists for that ID (either it has
     /// closed or the ID is invalid).
     ///
-    /// 

-    ///     
ⓘNote

-    /// 

     /// 

     /// 
     /// Note: This requires the wrapped subscriber to implement the
@@ -1038,9 +1029,6 @@ where
 
     /// Returns `true` if an active span exists for the given `Id`.
     ///
-    /// 

-    ///     
ⓘNote

-    /// 

     /// 

     /// 
     /// Note: This requires the wrapped subscriber to implement the
@@ -1063,9 +1051,6 @@ where
     ///
     /// If this returns `None`, then we are not currently within a span.
     ///
-    /// 

-    ///     
ⓘNote

-    /// 

     /// 

     /// 
     /// Note: This requires the wrapped subscriber to implement the
@@ -1100,9 +1085,6 @@ where
     ///
     /// If this iterator is empty, then there are no spans in the current context.
     ///
-    /// 

-    ///     
ⓘNote

-    /// 

     /// 

     /// 
     /// Note: This requires the wrapped subscriber to implement the
diff --git a/tracing-subscriber/src/registry/mod.rs b/tracing-subscriber/src/registry/mod.rs
index cc84e5fb5c..327531c1c0 100644
--- a/tracing-subscriber/src/registry/mod.rs
+++ b/tracing-subscriber/src/registry/mod.rs
@@ -94,9 +94,6 @@ pub trait LookupSpan<'a> {
 
     /// Returns the [`SpanData`] for a given `Id`, if it exists.
     ///
-    /// 

-    ///     
ⓘNote

-    /// 

     /// 

     /// 
     /// Note: users of the LookupSpan trait should
diff --git a/tracing/src/dispatcher.rs b/tracing/src/dispatcher.rs
index 4041c994fb..f03ff4b3d3 100644
--- a/tracing/src/dispatcher.rs
+++ b/tracing/src/dispatcher.rs
@@ -107,9 +107,6 @@
 //!
 //! // `my_subscriber` is now the default
 //! ```
-//! 

-//!     
ⓘNote

-//! 

 //! 

 //! 
 //! Note: The thread-local scoped dispatcher (with_default)
diff --git a/tracing/src/field.rs b/tracing/src/field.rs
index 2514336585..96416638c0 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

-/// 

 /// 

 /// 
 /// Note: Although this is implemented for both the
diff --git a/tracing/src/lib.rs b/tracing/src/lib.rs
index 83fbdd7f9c..1a3f6d0b05 100644
--- a/tracing/src/lib.rs
+++ b/tracing/src/lib.rs
@@ -52,8 +52,6 @@
 //! The [`span` module][span]'s documentation provides further details on how to
 //! use spans.
 //!
-//! 

-//!     
⚠ ️Warning

 //! 
 //!     Warning: In asynchronous code that uses async/await syntax,
 //!     Span::enter may produce incorrect traces if the returned drop
@@ -580,7 +578,6 @@
 //! ```
 //!
 //! 

-//!     
⚠ ️Warning

 //! 
 //! Warning: In general, libraries should not call
 //! set_global_default()! Doing so will cause conflicts when
@@ -769,9 +766,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 1053d2f8ae..14b9b69cfa 100644
--- a/tracing/src/span.rs
+++ b/tracing/src/span.rs
@@ -75,8 +75,6 @@
 //! // Dropping the `_enter` guard will exit the span.
 //!```
 //!
-//! 

-//!     
⚠ ️Warning

 //! 
 //!     Warning: In asynchronous code that uses async/await syntax,
 //!     Span::enter may produce incorrect traces if the returned drop
@@ -121,12 +119,9 @@
 //! });
 //! ```
 //!
-//! 

-//!     
ⓘNote

-//! 

 //! 

 //! 
-//! Note: Since entering a span takes &selfNote: Since entering a span takes &self, and
 //! Spans are Clone, Send, and
 //! Sync, it is entirely valid for multiple threads to enter the
 //! same span concurrently.
@@ -610,9 +605,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;
@@ -820,9 +813,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

-    /// 

     /// 

     /// 
     ///
@@ -1039,9 +1029,6 @@ impl Span {
     /// }
     /// ```
     ///
-    /// 

-    ///     
ⓘNote

-    /// 

     /// 

     /// 
     /// Note: The fields associated with a span are part of its