Skip to content
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

docs: remove divs from all notes/warnings #1572

Merged
merged 1 commit into from
Sep 16, 2021
Merged

Conversation

hawkw
Copy link
Member

@hawkw hawkw commented Sep 16, 2021

This branch removes the HTML <div> tags from the warning and note
blocks in the documentation, because they're screwing up RustDoc
rendering on docs.rs. We had done this previously on the master
branch, but apparently it never made it to v0.1.x.

This should fix #1571 once a new tracing version is published.

This branch removes the HTML `<div>` tags from the warning and note
blocks in the documentation, because they're screwing up RustDoc
rendering on docs.rs. We had done this previously on the `master`
branch, but apparently it never made it to `v0.1.x`.

This should fix #1571 once a new `tracing` version is published.
@hawkw hawkw self-assigned this Sep 16, 2021
@hawkw hawkw requested a review from a team as a code owner September 16, 2021 17:11
@hawkw hawkw merged commit f12176e into v0.1.x Sep 16, 2021
@hawkw hawkw deleted the eliza/rm-magic-formatting branch September 16, 2021 17:18
hawkw added a commit that referenced this pull request Sep 16, 2021
# 0.2.23 (September 16, 2021)

This release fixes a few bugs in the per-layer filtering API added in
v0.2.21.

### Fixed

- **env-filter**: Fixed excessive `EnvFilter` memory use ([#1568])
- **filter**: Fixed a panic that may occur in debug mode when using
  per-layer filters together with global filters ([#1569])
- Fixed incorrect documentation formatting ([#1572])

[#1568]: #1568
[#1569]: #1569
[#1572]: #1572
hawkw added a commit that referenced this pull request Sep 16, 2021
# 0.2.23 (September 16, 2021)

This release fixes a few bugs in the per-layer filtering API added in
v0.2.21.

### Fixed

- **env-filter**: Fixed excessive `EnvFilter` memory use ([#1568])
- **filter**: Fixed a panic that may occur in debug mode when using
  per-layer filters together with global filters ([#1569])
- Fixed incorrect documentation formatting ([#1572])

[#1568]: #1568
[#1569]: #1569
[#1572]: #1572
hawkw added a commit that referenced this pull request Sep 17, 2021
# 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
hawkw added a commit that referenced this pull request Sep 17, 2021
# 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
kaffarell pushed a commit to kaffarell/tracing that referenced this pull request May 22, 2024
This branch removes the HTML `<div>` tags from the warning and note
blocks in the documentation, because they're screwing up RustDoc
rendering on docs.rs. We had done this previously on the `master`
branch, but apparently it never made it to `v0.1.x`.

This should fix tokio-rs#1571 once a new `tracing` version is published.
kaffarell pushed a commit to kaffarell/tracing that referenced this pull request May 22, 2024
# 0.2.23 (September 16, 2021)

This release fixes a few bugs in the per-layer filtering API added in
v0.2.21.

### Fixed

- **env-filter**: Fixed excessive `EnvFilter` memory use ([tokio-rs#1568])
- **filter**: Fixed a panic that may occur in debug mode when using
  per-layer filters together with global filters ([tokio-rs#1569])
- Fixed incorrect documentation formatting ([tokio-rs#1572])

[tokio-rs#1568]: tokio-rs#1568
[tokio-rs#1569]: tokio-rs#1569
[tokio-rs#1572]: tokio-rs#1572
kaffarell pushed a commit to kaffarell/tracing that referenced this pull request May 22, 2024
# 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 ([tokio-rs#1572])

[tokio-rs#1572]: tokio-rs#1572
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants