docs: fix broken and unresolvable links #595
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit fixes several RustDoc links which were either broken (without references) or had unresolvable references. It looks like nightly RustDoc has recently gotten much smarter about finding links that were unresolvable. These had always been broken, but they used to silently 404. Now, the nightly build of RustDoc will emit a warning, which we deny, causing the build to fail. This should fix CI (as well as actually fixing the wrong links). Signed-off-by: Eliza Weisman <eliza@buoyant.io>
davidbarsky
approved these changes
Feb 21, 2020
hawkw
added a commit
that referenced
this pull request
Feb 24, 2020
Added: - `field::Empty` type for declaring empty fields whose values will be recorded later (#548) - `field::Value` implementations for `Wrapping` and `NonZero*` numbers (#538) Fixed: - Broken and unresolvable links in RustDoc (#595) Thanks to @oli-cosmian for contributing to this release! Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw
added a commit
that referenced
this pull request
Feb 24, 2020
### Added - `field::Empty` type for declaring empty fields whose values will be recorded later (#548) - `field::Value` implementations for `Wrapping` and `NonZero*` numbers (#538) ### Fixed - Broken and unresolvable links in RustDoc (#595) Thanks to @oli-cosmian for contributing to this release! Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw
added a commit
that referenced
this pull request
Feb 26, 2020
Added: - **field**: `field::Empty` type for declaring empty fields whose values will be recorded later (#548) - **field**: `field::Value` implementations for `Wrapping` and `NonZero*` numbers (#538) - **attributes**: Support for adding arbitrary literal fields to spans generated by `#[instrument]` (#569) - **attributes**: `#[instrument]` now emits a helpful compiler error when attempting to skip a function parameter (#600) Changed: - **attributes**: The `#[instrument]` attribute was placed under an on-by-default feature flag "attributes" (#603) Fixed: - Broken and unresolvable links in RustDoc (#595) Thanks to @oli-cosmian and @Kobzol for contributing to this release! Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw
added a commit
that referenced
this pull request
Feb 27, 2020
### Added - **field**: `field::Empty` type for declaring empty fields whose values will be recorded later (#548) - **field**: `field::Value` implementations for `Wrapping` and `NonZero*` numbers (#538) - **attributes**: Support for adding arbitrary literal fields to spans generated by `#[instrument]` (#569) - **attributes**: `#[instrument]` now emits a helpful compiler error when attempting to skip a function parameter (#600) ### Changed - **attributes**: The `#[instrument]` attribute was placed under an on-by-default feature flag "attributes" (#603) ### Fixed - Broken and unresolvable links in RustDoc (#595) Thanks to @oli-cosmian and @Kobzol for contributing to this release! Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw
added a commit
that referenced
this pull request
Feb 19, 2021
Added - Re-export the `log` crate so that users can ensure consistent versions ([#602]) - `AsLog` implementation for `tracing::LevelFilter` ([#1248]) - `AsTrace` implementation for `log::LevelFilter` ([#1248]) Fixed - **log-tracer**: Fixed `Log::enabled` implementation for `LogTracer` not calling `Subscriber::enabled` ([#1254]) - **log-tracer**: Fixed `Log::enabled` implementation for `LogTracer` not checking the max level hint ([#1247]) - Several documentation fixes ([#483], [#485], [#537], [#595], [#941], [#981]) [#483]: https://github.com/tokio-rs/tracing/pulls/483 [#485]: https://github.com/tokio-rs/tracing/pulls/485 [#537]: https://github.com/tokio-rs/tracing/pulls/537 [#595]: https://github.com/tokio-rs/tracing/pulls/595 [#605]: https://github.com/tokio-rs/tracing/pulls/604 [#941]: https://github.com/tokio-rs/tracing/pulls/941 [#1247]: https://github.com/tokio-rs/tracing/pulls/1247 [#1248]: https://github.com/tokio-rs/tracing/pulls/1248 [#1254]: https://github.com/tokio-rs/tracing/pulls/1254 Signed-off-by: Eliza Weisman <eliza@buoyant.io>
kaffarell
pushed a commit
to kaffarell/tracing
that referenced
this pull request
May 22, 2024
Added - Re-export the `log` crate so that users can ensure consistent versions ([tokio-rs#602]) - `AsLog` implementation for `tracing::LevelFilter` ([tokio-rs#1248]) - `AsTrace` implementation for `log::LevelFilter` ([tokio-rs#1248]) Fixed - **log-tracer**: Fixed `Log::enabled` implementation for `LogTracer` not calling `Subscriber::enabled` ([tokio-rs#1254]) - **log-tracer**: Fixed `Log::enabled` implementation for `LogTracer` not checking the max level hint ([tokio-rs#1247]) - Several documentation fixes ([tokio-rs#483], [tokio-rs#485], [tokio-rs#537], [tokio-rs#595], [tokio-rs#941], [tokio-rs#981]) [tokio-rs#483]: https://github.com/tokio-rs/tracing/pulls/483 [tokio-rs#485]: https://github.com/tokio-rs/tracing/pulls/485 [tokio-rs#537]: https://github.com/tokio-rs/tracing/pulls/537 [tokio-rs#595]: https://github.com/tokio-rs/tracing/pulls/595 [tokio-rs#605]: https://github.com/tokio-rs/tracing/pulls/604 [tokio-rs#941]: https://github.com/tokio-rs/tracing/pulls/941 [tokio-rs#1247]: https://github.com/tokio-rs/tracing/pulls/1247 [tokio-rs#1248]: https://github.com/tokio-rs/tracing/pulls/1248 [tokio-rs#1254]: https://github.com/tokio-rs/tracing/pulls/1254 Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit fixes several RustDoc links which were either broken
(without references) or had unresolvable references.
It looks like nightly RustDoc has recently gotten much smarter about
finding links that were unresolvable. These had always been broken, but
they used to silently 404. Now, the nightly build of RustDoc will emit a
warning, which we deny, causing the build to fail. This should fix CI
(as well as actually fixing the wrong links).
Signed-off-by: Eliza Weisman eliza@buoyant.io