docs: fix "sploded" formatting #771
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
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
yaahc
reviewed
Jun 30, 2020
tracing-core/src/dispatcher.rs
Outdated
| @@ -113,7 +113,7 @@ | |||
| //! </div> | |||
| //! <div class="example-wrap" style="display:inline-block"> | |||
| //! <pre class="ignore" style="white-space:normal;font:inherit;"> | |||
| //! <strong>Note</strong>:the thread-local scoped dispatcher <code>with_default</code> | |||
| //! <strong>Note</strong>:the thread-local scoped dispatcher (<code>with_default</code>) | |||
| //! requires the Rust standard library. <code>no_std</code> users should use | |||
There was a problem hiding this comment.
agh, still? it looked normal on my machine...
There was a problem hiding this comment.
might be a caching issue?
edit: ctrl-f5 refresh didn't fix it
There was a problem hiding this comment.
Oh, huh. It's messed up in the netlify deploy preview for me, too:
I definitely tested this locally with cargo doc --open and it looked right. I hate HTML!!!!
There was a problem hiding this comment.
what the hell! i messed with it some more and it looks right locally, and it still doesn't look nice on netlify.
There was a problem hiding this comment.
oh...it looks like netlify has not built a new deploy preview for my follow-up changes, which is why it looks the same. that's cool!!!
|
looks good for the most part |
yaahc
approved these changes
Jun 30, 2020
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw
added a commit
that referenced
this pull request
Jul 8, 2020
Changed - Replaced use of `inner_local_macros` with `$crate::` (#729) Added - `must_use` warning to guards returned by `dispatcher::set_default` (#686) - `fmt::Debug` impl to `dyn Value`s (#696) - Functions to convert between `span::Id` and `NonZeroU64` (#770) - More obvious warnings in documentation (#769) Fixed - Compiler error when `tracing-core/std` feature is enabled but `tracing/std` is not (#760) - Clippy warning on vtable address comparison in `callsite::Identifier` (#749) - Documentation formatting issues (#715, #771) Thanks to @bkchr, @majecty, @taiki-e, @nagisa, and @nqvz for contributing to this release!
hawkw
added a commit
that referenced
this pull request
Jul 8, 2020
### Changed - Replaced use of `inner_local_macros` with `$crate::` (#729) ### Added - `must_use` warning to guards returned by `dispatcher::set_default` (#686) - `fmt::Debug` impl to `dyn Value`s (#696) - Functions to convert between `span::Id` and `NonZeroU64` (#770) - More obvious warnings in documentation (#769) ### Fixed - Compiler error when `tracing-core/std` feature is enabled but `tracing/std` is not (#760) - Clippy warning on vtable address comparison in `callsite::Identifier` (#749) - Documentation formatting issues (#715, #771) Thanks to @bkchr, @majecty, @taiki-e, @nagisa, and @nvzqz for contributing to this release!
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.
Motivation
PR #769 was merged with some incorrect docs formatting due to
incorrect HTML that resulted from overzealous find-and-replace
misuse. See #769 (review)
Solution
This PR un-splodes it.