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

Fix broken tracing documentation formatting #881

Merged
merged 1 commit into from
Aug 3, 2020

Conversation

mystor
Copy link
Contributor

@mystor mystor commented Aug 3, 2020

I wasn't able to reproduce the exact formatting issues seen on docs.rs locally, though from some source inspection, this extra </div> appears to be the culprit.

(hopefully) fixes #880

@mystor mystor requested review from hawkw and a team as code owners August 3, 2020 18:48
Copy link
Member

@hawkw hawkw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this looks great to me.

The CI failure is not related; #882 should fix it. Mind rebasing when this is merged?

We should also do a quick check of the other warning boxes to make sure they don't have the same unclosed <div>.

It's a bummer that the netlify deploy preview doesn't catch this...probably you're right and it's closing a div that's docs.rs-specific.

@hawkw
Copy link
Member

hawkw commented Aug 3, 2020

Okay, we just merged PR #882 that should fix the CI failure. Mind rebasing onto that?

@hawkw hawkw merged commit a83e1bc into tokio-rs:master Aug 3, 2020
@jyn514
Copy link
Contributor

jyn514 commented Aug 5, 2020

This was probably because of rust-lang/docs.rs#930. Sorry it broke your docs - the reason it worked before is that we parsed the HTML from scratch instead of rewriting it, and so the parser could guess at the end tags.

I don't really have ideas for testing this ... maybe you could run tidy on the HTML rustdoc generates? That would have caught the unclosed tag.

@hawkw
Copy link
Member

hawkw commented Aug 5, 2020

This was probably because of rust-lang/docs.rs#930. Sorry it broke your docs - the reason it worked before is that we parsed the HTML from scratch instead of rewriting it, and so the parser could guess at the end tags.

Thanks for letting us know, and no need to apologize...it's really our fault for having an unclosed tag in our docs (and for using custom HTML in the first place)...

hawkw added a commit that referenced this pull request Aug 10, 2020
Fixed

- Updated `tracing-core` to fix incorrect calculation of the global max
  level filter (#908)

Added

- **attributes**: Support for using `self` in field expressions when
  instrumenting `async-trait` functions (#875)
- Several documentation improvements (#832, #881, #896, #897, #911,
  #913)

Thanks to @anton-dutov, @nightmared, @mystor, and @toshokan for
contributing to  this release!
hawkw added a commit that referenced this pull request Aug 11, 2020
### Fixed

- Updated `tracing-core` to fix incorrect calculation of the global max
  level filter (#908)

### Added

- **attributes**: Support for using `self` in field expressions when
  instrumenting `async-trait` functions (#875)
- Several documentation improvements (#832, #881, #896, #897, #911,
  #913)

Thanks to @anton-dutov, @nightmared, @mystor, and @toshokan for
contributing to  this release!

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

tracing docs.rs layout is broken
3 participants