mock: document public API in collector module #2389
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
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 adds documentation to the collector module itself and to all the public APIs in the module. This includes doctests on all the methods that serve as examples. Additionally the implementation for the `Expect` struct has been moved into the module with the definition, this was missed in #2369. Refs: #539
It creates too many issues (need to add `allow_deprecated` annotations all over the place) and they will actually make fixing those tests to use the new (but as yet unimplemented) `MockCollector::close_span` more difficult.
They are! I removed the referce to `MockCollector::close_span` as it doesn't yet exist.
Also cleaned up the text and tried to apply the code review comments from #2426 to what I'd written already.
hawkw
reviewed
Jan 5, 2023
tracing-mock/src/collector.rs
Outdated
| @@ -311,7 +313,7 @@ where | |||
| /// | |||
| /// [`Collect::drop_span`]: fn@tracing::Collect::drop_span | |||
| /// [`close_span`]: fn@Self::close_span | |||
| #[deprecated(since = "0.1.0", note = "use `MockCollector::close_span` instead")] | |||
There was a problem hiding this comment.
why was the deprecated attribute on this function removed?
There was a problem hiding this comment.
Adding the deprecated attribute meant adding #[allow_deprecated] on every single usage of it throughout the tracing tests. I felt it better to leave the deprecated attribute off until I can add a replacement. Then the current usage of drop_span can be replaced and this method can be marked as deprecated.
Co-authored-by: Eliza Weisman <eliza@buoyant.io>
All based on the lovely code review feedback I've been receiving.
… into hds/mock-collector-docs
hds
commented
Jan 10, 2023
The PR documenting the subscriber module.
|
I'm not really gonna be able to review the documentation for this; I trust that Eliza has gotten most of this. |
hawkw
approved these changes
Jun 23, 2023
davidbarsky
pushed a commit
that referenced
this pull request
Sep 26, 2023
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 adds documentation to the collector module itself and to all the public APIs in the module. This includes doctests on all the methods that serve as examples. Additionally the implementation for the `Expect` struct has been moved into the module with the definition, this was missed in #2369. Refs: #539
davidbarsky
pushed a commit
that referenced
this pull request
Sep 27, 2023
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 adds documentation to the collector module itself and to all the public APIs in the module. This includes doctests on all the methods that serve as examples. Additionally the implementation for the `Expect` struct has been moved into the module with the definition, this was missed in #2369. Refs: #539
davidbarsky
pushed a commit
that referenced
this pull request
Sep 27, 2023
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 adds documentation to the collector module itself and to all the public APIs in the module. This includes doctests on all the methods that serve as examples. Additionally the implementation for the `Expect` struct has been moved into the module with the definition, this was missed in #2369. Refs: #539
davidbarsky
pushed a commit
that referenced
this pull request
Sep 27, 2023
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 adds documentation to the collector module itself and to all the public APIs in the module. This includes doctests on all the methods that serve as examples. Additionally the implementation for the `Expect` struct has been moved into the module with the definition, this was missed in #2369. Refs: #539
hawkw
pushed a commit
that referenced
this pull request
Oct 1, 2023
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 adds documentation to the collector module itself and to all the public APIs in the module. This includes doctests on all the methods that serve as examples. Additionally the implementation for the `Expect` struct has been moved into the module with the definition, this was missed in #2369. Refs: #539
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.iofor some time. In order to make this possible, documentation and some
code clean up is needed.
Solution
This change adds documentation to the collector module itself and to all the
public APIs in the module. This includes doctests on all the methods
that serve as examples.
Additionally the implementation for the
Expectstruct has been movedinto the module with the definition, this was missed in #2369.
Refs: #539