Skip to content

Commit

Permalink
tracing: prepare to release 0.1.28
Browse files Browse the repository at this point in the history
# 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 `<div>`
  tag ([#1572])

[#1572]: #1572
  • Loading branch information
hawkw committed Sep 17, 2021
1 parent a792aa8 commit c2a823e
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 7 deletions.
13 changes: 13 additions & 0 deletions tracing/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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 `<div>` 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
Expand Down
2 changes: 1 addition & 1 deletion tracing/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ name = "tracing"
# - README.md
# - Update CHANGELOG.md.
# - Create "v0.1.x" git tag
version = "0.1.27"
version = "0.1.28"
authors = ["Eliza Weisman <eliza@buoyant.io>", "Tokio Contributors <team@tokio.rs>"]
license = "MIT"
readme = "README.md"
Expand Down
8 changes: 4 additions & 4 deletions tracing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Application-level tracing for Rust.
[Documentation][docs-url] | [Chat][discord-url]

[crates-badge]: https://img.shields.io/crates/v/tracing.svg
[crates-url]: https://crates.io/crates/tracing/0.1.27
[crates-url]: https://crates.io/crates/tracing/0.1.28
[docs-badge]: https://docs.rs/tracing/badge.svg
[docs-url]: https://docs.rs/tracing/0.1.27
[docs-url]: https://docs.rs/tracing/0.1.28
[docs-master-badge]: https://img.shields.io/badge/docs-master-blue
[docs-master-url]: https://tracing-rs.netlify.com/tracing
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
Expand Down Expand Up @@ -251,7 +251,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
Expand Down Expand Up @@ -298,7 +298,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
Expand Down
4 changes: 2 additions & 2 deletions tracing/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -795,7 +795,7 @@
//!
//! ```toml
//! [dependencies]
//! tracing = { version = "0.1.27", default-features = false }
//! tracing = { version = "0.1.28", default-features = false }
//! ```
//!
//! <pre class="ignore" style="white-space:normal;font:inherit;">
Expand Down Expand Up @@ -847,7 +847,7 @@
//! [flags]: #crate-feature-flags
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(docsrs, feature(doc_cfg), deny(rustdoc::broken_intra_doc_links))]
#![doc(html_root_url = "https://docs.rs/tracing/0.1.27")]
#![doc(html_root_url = "https://docs.rs/tracing/0.1.28")]
#![doc(
html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png",
issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
Expand Down

0 comments on commit c2a823e

Please sign in to comment.