docs: update Compact formatter docs
#1926
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>
hawkw
added a commit
that referenced
this pull request
Feb 17, 2022
# 0.3.9 (Feb 17, 2022) This release updates the minimum supported Rust version (MSRV) to 1.49.0, and updates the (optional) dependency on `parking_lot` to v0.12. ### Changed - Updated minimum supported Rust version (MSRV) to 1.49.0 ([#1913]) - `parking_lot`: updated to v0.12 ([008339d]) ### Added - **fmt**: Documentation improvements ([#1926], [#1927]) [#1913]: #1913 [#1926]: #1926 [#1927]: #1927 [008339d]: 008339d
hawkw
added a commit
that referenced
this pull request
Feb 18, 2022
# 0.3.9 (Feb 17, 2022) This release updates the minimum supported Rust version (MSRV) to 1.49.0, and updates the (optional) dependency on `parking_lot` to v0.12. ### Changed - Updated minimum supported Rust version (MSRV) to 1.49.0 ([#1913]) - `parking_lot`: updated to v0.12 ([008339d]) ### Added - **fmt**: Documentation improvements ([#1926], [#1927]) [#1913]: #1913 [#1926]: #1926 [#1927]: #1927 [008339d]: 008339d
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
Currently, the RustDoc for the
format::Compactformatter intracing-subscriberdescribes the output from themaster(v0.2.x)version of the formatter, not the version on the v0.1.x branch.
Solution
This PR updates the documentation to describe the actual output format.
Also, I added an example of the formatter in the
examplesdirectory.Closes #1909