backport changes from master
#1936
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
## Motivation I was scrolling through the code in `tracing/src/macros.rs` and noticed a possibly wrong log level in the `warn!` macro: https://github.com/tokio-rs/tracing/blob/4e65750b13721fee7a7ac05b053e1b9c3d21244f/tracing/src/macros.rs#L1698 ## Solution This branch changes the level to `Level::WARN` in the incorrect macro arm. Fixes: #1929 Co-authored-by: Nicolaas Geldenhuys <[email protected]>
## Motivation This PR adds [`tracing-forest`](https://crates.io/crates/tracing-forest) to the list of related crates. `tracing-forest` provides contextual coherence when writing logs, and is being used by projects like [Kanidm](https://github.com/kanidm/kanidm/). ## Solution I added it to the documentation in `lib.rs` and in the README. Am I missing anything else?
## Motivation Currently, the documentation for the `fmt` module shows examples of the output for each formatter in the top-level module. This is a lot of text that makes finding other things in the documentation more difficult. Meanwhile, the type-level docs for the various formatters are quite terse and don't offer much useful information. ## Solution This branch moves the example output to the type-level docs for the various formatters, and links to it from the list of formatters. I've also updated and expanded some of the documentation for the formatters, and added a similar list of formatters to the `fmt::format` module. Hopefully, this makes things easier to navigate? Finally, I've re-generated all example output with the latest versions of each formatter. ## Alternatives Alternatively, we could not move the example output. The initial intention for putting it in the top-level `fmt` module docs was to make it _very_ easy to find what the different formats look like. Perhaps this is worth having a lot of text to scroll through in the module-level docs?
davidbarsky
approved these changes
Feb 17, 2022
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.
this backports #1930 along with some documentation improvements, to prep for
tracingandtracing-subscriberreleases