attributes: update docs for instrument #2908
Open
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
mladedav
force-pushed
the
dm/instrument-docs
branch
from
3da25dd
to
1a08d4f
Compare
kaffarell
approved these changes
May 2, 2024
tracing-attributes/src/lib.rs
Outdated
| /// | ||
| /// Note that overlap between the names of fields and (non-skipped) arguments | ||
| /// will result in a compile error. | ||
| /// will result in recording the value provided to the macro. |
There was a problem hiding this comment.
I would add something like "and ignore the value provided to the function." to the sentence as this could be a slightly unpleasant surprise.
There was a problem hiding this comment.
Done. I've also changed the paragraph just before because I've noticed it might also be misleading out of context.
mladedav
force-pushed
the
dm/instrument-docs
branch
2 times, most recently
from
300c525
to
da2bd78
Compare
mladedav
force-pushed
the
dm/instrument-docs
branch
from
da2bd78
to
17cfc90
Compare
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
Docs were obsolete for the
instrumentmacro.Closes #2895
Solution
I've updated the docs and addeda a doctest example.
This should also be cherry-picked onto
v0.1.x