From 4be4c205fd03e5439563676bbf02c134c4713d48 Mon Sep 17 00:00:00 2001 From: Eliza Weisman Date: Fri, 17 Sep 2021 14:26:21 -0700 Subject: [PATCH] tracing: prepare to release 0.1.28 (#1577) # 0.1.28 (September 17th, 2021) This release fixes an issue where the RustDoc documentation was rendered incorrectly. It doesn't include any actual code changes, and is very boring and can be ignored. ### Fixed - **docs**: Incorrect documentation rendering due to unclosed `
` tag ([#1572]) [#1572]: https://github.com/tokio-rs/tracing/pull/1572 --- tracing/CHANGELOG.md | 13 +++++++++++++ tracing/README.md | 4 ++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/tracing/CHANGELOG.md b/tracing/CHANGELOG.md index 775e4a4d2..8d8bac4b1 100644 --- a/tracing/CHANGELOG.md +++ b/tracing/CHANGELOG.md @@ -1,3 +1,16 @@ +# 0.1.28 (September 17th, 2021) + +This release fixes an issue where the RustDoc documentation was rendered +incorrectly. It doesn't include any actual code changes, and is very boring and +can be ignored. + +### Fixed + +- **docs**: Incorrect documentation rendering due to unclosed `
` tag + ([#1572]) + +[#1572]: https://github.com/tokio-rs/tracing/pull/1572 + # 0.1.27 (September 13, 2021) This release adds a new [`Span::or_current`] method to aid in efficiently diff --git a/tracing/README.md b/tracing/README.md index 250e77ad3..3c68f1527 100644 --- a/tracing/README.md +++ b/tracing/README.md @@ -250,7 +250,7 @@ my_future is as long as the future's. The second, and preferred, option is through the -[`#[instrument]`](https://docs.rs/tracing/0.1.27/tracing/attr.instrument.html) +[`#[instrument]`](https://docs.rs/tracing/0.1.28/tracing/attr.instrument.html) attribute: ```rust @@ -297,7 +297,7 @@ span.in_scope(|| { // Dropping the span will close it, indicating that it has ended. ``` -The [`#[instrument]`](https://docs.rs/tracing/0.1.27/tracing/attr.instrument.html) attribute macro +The [`#[instrument]`](https://docs.rs/tracing/0.1.28/tracing/attr.instrument.html) attribute macro can reduce some of this boilerplate: ```rust