Fix rustdoc warning #1061
Merged
Fix rustdoc warning #1061
Conversation
This file contains hidden or 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
I've been seeing this warning from `tracing-subscriber` for quite a long time.
Running `cargo doc` gives this:
```
warning: could not parse code block as Rust code
--> /home/veetaha/.cargo/registry/src/github.zerozr99.workers.dev-1ecc6299db9ec823/tracing-subscriber-0.2.13/src/fmt/format/json.rs:30:5
|
30 | /// ```ignore,json
| _____^
31 | | /// {
32 | | /// "timestamp":"Feb 20 11:28:15.096",
33 | | /// "level":"INFO",
... |
38 | | /// }
39 | | /// ```
| |_______^
|
= note: error from rustc: unterminated double quote string
```
I guess it's me who dares fix this then :D
davidbarsky
approved these changes
Oct 22, 2020
Member
davidbarsky
left a comment
davidbarsky
left a comment
There was a problem hiding this comment.
Thanks! This has been a bit annoying :)
dvdplm
added a commit
to dvdplm/tracing
that referenced
this pull request
Oct 23, 2020
* upstream/master: subscriber: update sharded-slab to 0.1, pool hashmap allocations (tokio-rs#1062) subscriber: remove deprecated type, structs, and methods tokio-rs#1030 core: rename Subscriber to Collect (tokio-rs#1015) chore: fix rustdoc warning in tracing-subscriber (tokio-rs#1061)
dvdplm
added a commit
to dvdplm/tracing
that referenced
this pull request
Oct 23, 2020
* dp-target-is-cow: subscriber: update sharded-slab to 0.1, pool hashmap allocations (tokio-rs#1062) subscriber: remove deprecated type, structs, and methods tokio-rs#1030 core: rename Subscriber to Collect (tokio-rs#1015) chore: fix rustdoc warning in tracing-subscriber (tokio-rs#1061)
dvdplm
added a commit
to dvdplm/tracing
that referenced
this pull request
Oct 23, 2020
…spatch-as-owned-tokio-rs#455 * upstream/master: subscriber: update sharded-slab to 0.1, pool hashmap allocations (tokio-rs#1062) subscriber: remove deprecated type, structs, and methods tokio-rs#1030 core: rename Subscriber to Collect (tokio-rs#1015) chore: fix rustdoc warning in tracing-subscriber (tokio-rs#1061)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I've been seeing this warning from
tracing-subscriberfor quite a long time.Running
cargo docgives this:I guess it's me who dares fix this then :D