mock: document public APIs in span module
#2442
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
This change adds documentation to the span module and all the public APIs within it. This includes doctests on all the methods which serve as examples. Additionally, the validation on `ExpectedSpan` was improved so that it validates the level and target during `enter` and `exit` as well as on `new_span`. The method `ExpectedSpan::with_field` was renamed to `with_fields` (plural) to match the same method on `ExpectedEvent` (and because multiple fields can be passed to it). A copy-paste typo was also fixed in the documentation for `ExpectedEvent::with_contextual_parent`. Refs: #539
The collector doctests needed to be updated to take into consideration the newly renamed method `ExpectedSpan::with_fields` (was `with_field`).
davidbarsky
requested changes
Oct 25, 2023
Co-authored-by: David Barsky <[email protected]>
davidbarsky
reviewed
Oct 28, 2023
|
after my suggestions are applied, this looks good to me :) |
Co-authored-by: David Barsky <[email protected]>
hds
commented
Oct 31, 2023
There was a problem hiding this comment.
@davidbarsky I made all the changes, except one that I think needed rewording, what do you think?
davidbarsky
approved these changes
Nov 13, 2023
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-mock to crates.io
for some time. In order to make this possible, documentation and some
code clean up is needed.
The
spanmodule needs documentation and examples.Solution
This change adds documentation to the span module and all the public
APIs within it. This includes doctests on all the methods which serve as
examples.
Additionally, the validation on
ExpectedSpanwas improved so that itvalidates the level and target during
enterandexitas well as onnew_span.The method
ExpectedSpan::with_fieldwas renamed towith_fields(plural) to match the same method on
ExpectedEvent(and becausemultiple fields can be passed to it).
A copy-paste typo was also fixed in the documentation for
ExpectedEvent::with_contextual_parent.Refs: #539