Skip to content

Commit

Permalink
docs: add missing tracing crate links (#1652)
Browse files Browse the repository at this point in the history
Add missing links to the `tracing` crate in crate-level documentation
for `gateway-queue`, `http-ratelimiting`, and `lavalink`. This causes
rustdoc errors when building individual crates.
  • Loading branch information
zeylahellyer authored Apr 4, 2022
1 parent c1ff126 commit e058937
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 4 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,8 +201,8 @@ async fn handle_event(

## Note about tracing

When using the `tracing` crate you won't, by default, see logs from any
libraries that use the `log` crate. You can add that back by using the
When using the [`tracing`] crate you won't, by default, see logs from any
libraries that use the [`log`] crate. You can add that back by using the
[`tracing-log`] crate and initializing it like this:

```rust
Expand Down Expand Up @@ -231,7 +231,9 @@ All first-party crates are licensed under [ISC][LICENSE.md]
[license link]: https://github.com/twilight-rs/twilight/blob/main/LICENSE.md
[logo]: https://raw.githubusercontent.com/twilight-rs/twilight/main/logo.png
[rust badge]: https://img.shields.io/badge/rust-1.57+-93450a.svg?style=for-the-badge&logo=rust
[`log`]: https://crates.io/crates/log
[`tracing-log`]: https://github.com/tokio-rs/tracing/tree/master/tracing-log
[`tracing`]: https://crates.io/crates/tracing
[`twilight-cache-inmemory`]: https://twilight.rs/chapter_1_crates/section_4_cache_inmemory.html
[`twilight-embed-builder`]: https://twilight.rs/chapter_1_crates/section_7_first_party/section_1_embed_builder.html
[`twilight-gateway-queue`]: https://twilight.rs/chapter_1_crates/section_7_first_party/section_5_gateway_queue.html
Expand Down
1 change: 1 addition & 0 deletions gateway-queue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ The `tracing` feature enables logging via the [`tracing`] crate.

This is enabled by default.

[`tracing`]: https://crates.io/crates/tracing
[Sharding for Very Large Bots]: https://discord.com/developers/docs/topics/gateway#sharding-for-very-large-bots

<!-- cargo-sync-readme end -->
1 change: 1 addition & 0 deletions gateway-queue/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
//!
//! This is enabled by default.
//!
//! [`tracing`]: https://crates.io/crates/tracing
//! [Sharding for Very Large Bots]: https://discord.com/developers/docs/topics/gateway#sharding-for-very-large-bots
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
Expand Down
1 change: 1 addition & 0 deletions http-ratelimiting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The `tracing` feature enables logging via the [`tracing`] crate.

This is enabled by default.

[`tracing`]: https://crates.io/crates/tracing
[Discord's documentation]: https://discord.com/developers/docs/topics/rate-limits

<!-- cargo-sync-readme end -->
1 change: 1 addition & 0 deletions http-ratelimiting/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
//!
//! This is enabled by default.
//!
//! [`tracing`]: https://crates.io/crates/tracing
//! [Discord's documentation]: https://discord.com/developers/docs/topics/rate-limits
#![deny(
Expand Down
1 change: 1 addition & 0 deletions lavalink/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ There is also an example of a basic bot located in the [root of the
[`rustls`]: https://crates.io/crates/rustls
[`rustls-native-certs`]: https://crates.io/crates/rustls-native-certs
[`tokio-tungstenite`]: https://crates.io/crates/tokio-tungstenite
[`tracing`]: https://crates.io/crates/tracing
[`webpki-roots`]: https://crates.io/crates/webpki-roots
[client]: Lavalink
[codecov badge]: https://img.shields.io/codecov/c/gh/twilight-rs/twilight?logo=codecov&style=for-the-badge&token=E9ERLJL0L2
Expand Down
1 change: 1 addition & 0 deletions lavalink/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@
//! [`rustls`]: https://crates.io/crates/rustls
//! [`rustls-native-certs`]: https://crates.io/crates/rustls-native-certs
//! [`tokio-tungstenite`]: https://crates.io/crates/tokio-tungstenite
//! [`tracing`]: https://crates.io/crates/tracing
//! [`webpki-roots`]: https://crates.io/crates/webpki-roots
//! [client]: Lavalink
//! [codecov badge]: https://img.shields.io/codecov/c/gh/twilight-rs/twilight?logo=codecov&style=for-the-badge&token=E9ERLJL0L2
Expand Down
6 changes: 4 additions & 2 deletions twilight/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,8 @@
//!
//! ## Note about tracing
//!
//! When using the `tracing` crate you won't, by default, see logs from any
//! libraries that use the `log` crate. You can add that back by using the
//! When using the [`tracing`] crate you won't, by default, see logs from any
//! libraries that use the [`log`] crate. You can add that back by using the
//! [`tracing-log`] crate and initializing it like this:
//!
//! ```rust
Expand Down Expand Up @@ -231,7 +231,9 @@
//! [license link]: https://github.com/twilight-rs/twilight/blob/main/LICENSE.md
//! [logo]: https://raw.githubusercontent.com/twilight-rs/twilight/main/logo.png
//! [rust badge]: https://img.shields.io/badge/rust-1.57+-93450a.svg?style=for-the-badge&logo=rust
//! [`log`]: https://crates.io/crates/log
//! [`tracing-log`]: https://github.com/tokio-rs/tracing/tree/master/tracing-log
//! [`tracing`]: https://crates.io/crates/tracing
//! [`twilight-cache-inmemory`]: https://twilight.rs/chapter_1_crates/section_4_cache_inmemory.html
//! [`twilight-embed-builder`]: https://twilight.rs/chapter_1_crates/section_7_first_party/section_1_embed_builder.html
//! [`twilight-gateway-queue`]: https://twilight.rs/chapter_1_crates/section_7_first_party/section_5_gateway_queue.html
Expand Down

0 comments on commit e058937

Please sign in to comment.