Fixes a typo and adds a note about the supported field syntax #1232
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
hawkw
approved these changes
Feb 9, 2021
tracing/src/lib.rs
Outdated
Comment on lines
195
to
196
| //! The [`span!`] and [`event!`] macros as well as the `#[tracing::instrument]` attribute | ||
| //! use fairly similar syntax, with some exceptions. |
There was a problem hiding this comment.
if you're up for it, it would be nice to make this part of the change on the master branch as well --- these docs should be about the same, unlike the attribute's docs.
|
Thanks for the review! |
|
Oh no please go ahead, sorry I didn't get to it earlier!
…On Thu, Feb 11, 2021 at 10:33 PM Eliza Weisman ***@***.***> wrote:
@lfrancke <https://github.com/lfrancke> mind if I just go ahead and make
the suggested changes here? I'd like to publish a tracing-attributes
release today with #1236 <#1236>,
and it would be nice to get the docs fixes in as well.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#1232 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAA57YQTEEEGIAYWM3HN6ALS6RELRANCNFSM4XKWPA5Q>
.
|
Co-authored-by: Eliza Weisman <eliza@buoyant.io>
hawkw
approved these changes
Feb 12, 2021
| @@ -192,8 +192,8 @@ | |||
| //! | |||
| //! ## Using the Macros | |||
| //! | |||
| //! The [`span!`] and [`event!`] macros use fairly similar syntax, with some | |||
| //! exceptions. | |||
| //! The [`span!`] and [`event!`] macros as well as the `#[instrument]` attribute | |||
There was a problem hiding this comment.
it might be nice if #[instrument] was a link as well, but not a hard blocker.
hawkw
added a commit
that referenced
this pull request
Feb 17, 2021
Fixed - **attributes**: Compiler error when using `#[instrument(err)]` on functions which return `impl Trait` ([#1236]) - Fixed broken match arms in event macros ([#1239]) - Documentation improvements ([#1232]) Thanks to @bkchr and @lfranke for contributing to this release! [#1236]: #1236 [#1239]: #1239 [#1232]: #1232 Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw
added a commit
that referenced
this pull request
Feb 17, 2021
### Fixed - **attributes**: Compiler error when using `#[instrument(err)]` on functions which return `impl Trait` ([#1236]) - Fixed broken match arms in event macros ([#1239]) - Documentation improvements ([#1232]) Thanks to @bkchr and @lfranke for contributing to this release! [#1236]: #1236 [#1239]: #1239 [#1232]: #1232 Signed-off-by: Eliza Weisman <eliza@buoyant.io>
|
I'm sorry for the super slow responses. I'm swamped at the moment. |
kaffarell
pushed a commit
to kaffarell/tracing
that referenced
this pull request
May 22, 2024
…okio-rs#1232) The `instrument` macro does not explain the syntax that can be used and the main tracing docs only say that this syntax is valid for `span` and `event` macros. Co-authored-by: Eliza Weisman <eliza@buoyant.io>
kaffarell
pushed a commit
to kaffarell/tracing
that referenced
this pull request
May 22, 2024
### Fixed - **attributes**: Compiler error when using `#[instrument(err)]` on functions which return `impl Trait` ([tokio-rs#1236]) - Fixed broken match arms in event macros ([tokio-rs#1239]) - Documentation improvements ([tokio-rs#1232]) Thanks to @bkchr and @lfranke for contributing to this release! [tokio-rs#1236]: tokio-rs#1236 [tokio-rs#1239]: tokio-rs#1239 [tokio-rs#1232]: tokio-rs#1232 Signed-off-by: Eliza Weisman <eliza@buoyant.io>
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.
The
instrumentmacro does not explain the syntax that can be used andthe main tracing docs only say that this syntax is valid for
spanandeventmacros.