Skip to content

Commit 23e0491

Browse files
committed
fixed broken links in code docs
1 parent ef9a1e0 commit 23e0491

File tree

4 files changed

+16
-18
lines changed

4 files changed

+16
-18
lines changed

tracing-appender/src/lib.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
//!
2323
//! This crate can be used in a few ways to record spans/events:
2424
//! - Using a [`RollingFileAppender`] to perform writes to a log file. This will block on writes.
25-
//! - Using *any* type implementing [`std::io::Write`][write] in a non-blocking fashion.
25+
//! - Using *any* type implementing [`std::io::Write`] in a non-blocking fashion.
2626
//! - Using a combination of [`NonBlocking`] and [`RollingFileAppender`] to allow writes to a log file
2727
//! without blocking.
2828
//!
@@ -48,7 +48,7 @@
4848
//! # }
4949
//! ```
5050
//!
51-
//! The file appender implements [`std::io::Write`][write]. To be used with
51+
//! The file appender implements [`std::io::Write`]. To be used with
5252
//! [`tracing_subscriber::FmtSubscriber`][fmt_subscriber], it must be combined with a
5353
//! [`MakeWriter`][make_writer] implementation to be able to record tracing spans/event.
5454
//!
@@ -68,12 +68,12 @@
6868
//! .init();
6969
//! # }
7070
//! ```
71-
//! **Note:** `_guard` is a [`WorkerGuard`][guard] which is returned by [`tracing_appender::non_blocking`][non_blocking]
71+
//! **Note:** `_guard` is a [`WorkerGuard`] which is returned by [`tracing_appender::non_blocking`][non_blocking]
7272
//! to ensure buffered logs are flushed to their output in the case of abrupt terminations of a process.
7373
//! See [`WorkerGuard` module][guard] for more details.
7474
//!
7575
//! The example below demonstrates the construction of a [`tracing_appender::non_blocking`][non_blocking]
76-
//! writer constructed with a [`std::io::Write`][write]:
76+
//! writer constructed with a [`std::io::Write`]:
7777
//!
7878
//! ```rust
7979
//! use std::io::Error;

tracing-appender/src/non_blocking.rs

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
//! Unintentional drops of `WorkerGuard` remove the guarantee that logs will be flushed
3232
//! during a program's termination, in a panic or otherwise.
3333
//!
34-
//! See [`WorkerGuard`][worker_guard] for examples of using the guard.
34+
//! See [`WorkerGuard`] for examples of using the guard.
3535
//!
3636
//! [worker_guard]: WorkerGuard
3737
//!
@@ -60,8 +60,8 @@ use tracing_subscriber::fmt::MakeWriter;
6060

6161
/// The default maximum number of buffered log lines.
6262
///
63-
/// If [`NonBlocking`][non-blocking] is lossy, it will drop spans/events at capacity.
64-
/// If [`NonBlocking`][non-blocking] is _not_ lossy,
63+
/// If [`NonBlocking`] is lossy, it will drop spans/events at capacity.
64+
/// If [`NonBlocking`] is _not_ lossy,
6565
/// backpressure will be exerted on senders, causing them to block their
6666
/// respective threads until there is available capacity.
6767
///
@@ -117,12 +117,10 @@ pub struct WorkerGuard {
117117
/// `NonBlocking` moves the writing out of an application's data path by sending spans and events
118118
/// to a dedicated logging thread.
119119
///
120-
/// This struct implements [`MakeWriter`][make_writer] from the `tracing-subscriber`
121-
/// crate. Therefore, it can be used with the [`tracing_subscriber::fmt`][fmt] module
120+
/// This struct implements `MakeWriter` from the `tracing-subscriber`
121+
/// crate. Therefore, it can be used with the [`tracing_subscriber::fmt()`] module
122122
/// or with any other collector/subscriber implementation that uses the `MakeWriter` trait.
123123
///
124-
/// [make_writer]: tracing_subscriber::fmt::MakeWriter
125-
/// [fmt]: mod@tracing_subscriber::fmt
126124
#[derive(Clone, Debug)]
127125
pub struct NonBlocking {
128126
error_counter: ErrorCounter,
@@ -187,7 +185,7 @@ impl NonBlocking {
187185
}
188186
}
189187

190-
/// A builder for [`NonBlocking`][non-blocking].
188+
/// A builder for [`NonBlocking`].
191189
///
192190
/// [non-blocking]: NonBlocking
193191
#[derive(Debug)]

tracing-journald/src/lib.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -517,11 +517,11 @@ pub struct PriorityMappings {
517517
impl PriorityMappings {
518518
/// Returns the default priority mappings:
519519
///
520-
/// - [`tracing::Level::ERROR`][]: [`Priority::Error`] (3)
521-
/// - [`tracing::Level::WARN`][]: [`Priority::Warning`] (4)
522-
/// - [`tracing::Level::INFO`][]: [`Priority::Notice`] (5)
523-
/// - [`tracing::Level::DEBUG`][]: [`Priority::Informational`] (6)
524-
/// - [`tracing::Level::TRACE`][]: [`Priority::Debug`] (7)
520+
/// - `tracing::Level::ERROR`: [`Priority::Error`] (3)
521+
/// - `tracing::Level::WARN`: [`Priority::Warning`] (4)
522+
/// - `tracing::Level::DEBUG`: [`Priority::Informational`] (6)
523+
/// - `tracing::Level::INFO`: [`Priority::Notice`] (5)
524+
/// - `tracing::Level::TRACE`: [`Priority::Debug`] (7)
525525
pub fn new() -> PriorityMappings {
526526
Self {
527527
error: Priority::Error,

tracing-subscriber/src/subscribe/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -471,7 +471,7 @@
471471
//! trait may also be implemented for user-defined types.
472472
//!
473473
//! [`Option<Filter>`] also implements [`Filter`], which allows for an optional
474-
//! filter. [`None`](Option::None) filters out _nothing_ (that is, allows
474+
//! filter. [`None`] filters out _nothing_ (that is, allows
475475
//! everything through). For example:
476476
//!
477477
//! ```rust

0 commit comments

Comments
 (0)