mock: add README to tracing-mock #2357
Closed
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
There has been interest around publishing `tracing-mock` to crates.io for some time. In order to make this possible, documentation and some code clean up is needed. This change starts that process by adding a README for `tracing-mock`. The README follows the standard format for all `tracing` crates and includes 2 examples. Additionally an integration test has been added for each example. Refs: #539
|
Thanks for opening this PR! Before I review the rest of this PR, can you retarget this PR to point towards master instead of |
Sure, I'll do that. I was unsure about where to make these changes, so now I know. (-: |
|
Closing this PR in favor of one targeting master instead: #2362 |
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
There has been interest around publishing
tracing-mockto crates.io for some time. In order to make this possible, documentation and some code clean up is needed.Specifically I want to have access to
tracing-mockwithin parts oftokioto write tests that ensure that the correct calling location is picked up for allspawn*functions when thetracingfeature is enabled.Solution
This change starts that process by adding a README for
tracing-mock. The README follows the standard format for alltracingcrates and includes 2 examples. Additionally an integration test has been added for each example.Refs: #539