itsscb/tracing
1
0
Fork 0
mirror of https://github.com/tokio-rs/tracing.git synced 2025-10-24 10:05:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

tracing: fix docs typos and warnings(#2581)

Browse Source 
## Motivation

When reading the docs I noticed some typo's and while fixing them I
noticed warnings from cargo doc

## Solution

Fixed the typos and the doc warnings in tracing

Co-authored-by: Neulichedl, Patrick - D0E05450 <Patrick.Neulichedl@dm-b2b.com>
This commit is contained in:
Patrick Neulichedl 2023-05-05 18:58:35 +02:00 committed by GitHub
parent 3de7f8c601
commit 24fa710237
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
tracing/src/field.rs
View File

@ -1,13 +1,13 @@
//! `Span` and `Event` key-value data. //! `Span` and `Event` key-value data.
//! //!
//! Spans and events may be annotated with key-value data, referred to as known //! Spans and events may be annotated with key-value data, referred to as _fields_.
//! as _fields_. These fields consist of a mapping from a key (corresponding to //! These fields consist of a mapping from a key (corresponding to
//! a `&str` but represented internally as an array index) to a [`Value`]. //! a `&str` but represented internally as an array index) to a [`Value`].
//! //!
//! # `Value`s and `Subscriber`s //! # `Value`s and `Subscriber`s
//! //!
//! `Subscriber`s consume `Value`s as fields attached to [span]s or [`Event`]s. //! `Subscriber`s consume `Value`s as fields attached to [span]s or [`Event`]s.
//! The set of field keys on a given span or is defined on its [`Metadata`]. //! The set of field keys on a given span or event is defined on its [`Metadata`].
//! When a span is created, it provides [`Attributes`] to the `Subscriber`'s //! When a span is created, it provides [`Attributes`] to the `Subscriber`'s
//! [`new_span`] method, containing any fields whose values were provided when //! [`new_span`] method, containing any fields whose values were provided when
//! the span was created; and may call the `Subscriber`'s [`record`] method //! the span was created; and may call the `Subscriber`'s [`record`] method
@ -126,7 +126,6 @@ use crate::Metadata;
/// string comparisons. Thus, if possible, once the key for a field is known, it /// string comparisons. Thus, if possible, once the key for a field is known, it
/// should be used whenever possible. /// should be used whenever possible.
/// </pre> /// </pre>
/// </div>
pub trait AsField: crate::sealed::Sealed { pub trait AsField: crate::sealed::Sealed {
/// Attempts to convert `&self` into a `Field` with the specified `metadata`. /// Attempts to convert `&self` into a `Field` with the specified `metadata`.
/// ///

2
tracing/src/span.rs
View File

@ -824,7 +824,7 @@ impl Span {
/// ///
/// <pre class="ignore" style="white-space:normal;font:inherit;"> /// <pre class="ignore" style="white-space:normal;font:inherit;">
/// <strong>Note</strong>: The returned <a href="../struct.EnteredSpan.html"> /// <strong>Note</strong>: The returned <a href="../struct.EnteredSpan.html">
/// <code>EnteredSpan</a></code> guard does not implement <code>Send</code>. /// <code>EnteredSpan</code></a> guard does not implement <code>Send</code>.
/// Dropping the guard will exit <em>this</em> span, and if the guard is sent /// Dropping the guard will exit <em>this</em> span, and if the guard is sent
/// to another thread and dropped there, that thread may never have entered /// to another thread and dropped there, that thread may never have entered
/// this span. Thus, <code>EnteredSpan</code>s should not be sent between threads. /// this span. Thus, <code>EnteredSpan</code>s should not be sent between threads.