New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add deny(broken_intra_doc_links)
#981
Changes from 11 commits
4f6bddc
9ac5195
4e11097
542f431
d2bd001
4b60c4d
a5a9fbd
66a84e8
1766a9e
58aade4
ead12cf
8b902f4
6b112a3
56d0753
6d0ee28
1f54df4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -91,7 +91,7 @@ | |
issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" | ||
)] | ||
#![cfg_attr(not(feature = "std"), no_std)] | ||
#![cfg_attr(docsrs, feature(doc_cfg))] | ||
#![cfg_attr(docsrs, feature(doc_cfg), deny(broken_intra_doc_links))] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. huh, i've never seen this form of There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I didn't even know about it until a while ago, but rust-lang/rust#54862 Implemented cfg_attr with multiple attributes! |
||
#![warn( | ||
missing_debug_implementations, | ||
missing_docs, | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -636,7 +636,7 @@ | |
//! ### Emitting `log` Records | ||
//! | ||
//! This crate provides two feature flags, "log" and "log-always", which will | ||
//! cause [spans] and [events] to emit `log` records. When the "log" feature is | ||
//! cause [spans][span] and [events][event] to emit `log` records. When the "log" feature is | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we wrap this at the same column as the other lines in this comment? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've fixed this! |
||
//! enabled, if no `tracing` `Subscriber` is active, invoking an event macro or | ||
//! creating a span with fields will emit a `log` record. This is intended | ||
//! primarily for use in libraries which wish to emit diagnostics that can be | ||
|
@@ -671,7 +671,7 @@ | |
//! | ||
//! The [`tracing-log`] crate provides a compatibility layer which | ||
//! allows a `tracing` [`Subscriber`] to consume `log` records as though they | ||
//! were `tracing` [events]. This allows applications using `tracing` to record | ||
//! were `tracing` [events][event]. This allows applications using `tracing` to record | ||
TaKO8Ki marked this conversation as resolved.
Show resolved
Hide resolved
|
||
//! the logs emitted by dependencies using `log` as events within the context of | ||
//! the application's trace tree. See [that crate's documentation][log-tracer] | ||
//! for details. | ||
|
@@ -844,7 +844,7 @@ | |
//! [instrument]: https://docs.rs/tracing-attributes/latest/tracing_attributes/attr.instrument.html | ||
//! [flags]: #crate-feature-flags | ||
#![cfg_attr(not(feature = "std"), no_std)] | ||
#![cfg_attr(docsrs, feature(doc_cfg))] | ||
#![cfg_attr(docsrs, feature(doc_cfg), deny(broken_intra_doc_links))] | ||
#![doc(html_root_url = "https://docs.rs/tracing/0.1.20")] | ||
#![doc( | ||
html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png", | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nice to explain briefly why this is necessary rather than just running
cargo doc