Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Suggested doc fix #340

Merged
merged 2 commits into from Sep 12, 2019
Merged

Suggested doc fix #340

merged 2 commits into from Sep 12, 2019

Conversation

samscott89
Copy link
Contributor

Suggested documentation fix for confusion in #306

@samscott89 samscott89 changed the title Suggested doc dix Suggested doc fix Sep 11, 2019
hawkw
hawkw reviewed Sep 11, 2019
View reviewed changes
Copy link
Member

@hawkw hawkw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix, I agree that this is clearer! There are a couple tweaks I'd like to make before merging this.

tracing-core/src/field.rs Outdated
@@ -219,6 +219,8 @@ pub trait Value: crate::sealed::Sealed {
}

/// A `Value` which serializes as a string using `fmt::Display`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we should also remove the "as a string", as well, if this was a source of confusion?

tracing-core/src/field.rs Show resolved Hide resolved
hawkw
hawkw approved these changes Sep 11, 2019
View reviewed changes
Copy link
Member

@hawkw hawkw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@hawkw
Copy link
Member

hawkw commented Sep 12, 2019

@samscott89 i believe that if you rebase or merge master, the CI build for this should be fixed.

@hawkw hawkw merged commit 4c2b604 into tokio-rs:master Sep 12, 2019
hawkw added a commit that referenced this pull request Sep 12, 2019
@hawkw
core: prepare to release version 0.1.6
642102a 
Added:

- Internal APIs to support performance optimizations (#326)

Fixed:

- Clarified wording in `field::display` documentation (#340)

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
@hawkw hawkw mentioned this pull request Sep 12, 2019
Merged
hawkw added a commit that referenced this pull request Sep 12, 2019
@hawkw
core: prepare to release version 0.1.6 (#343)
930bd73 
Added:

- Internal APIs to support performance optimizations (#326)

Fixed:

- Clarified wording in `field::display` documentation (#340)

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
@hawkw hawkw mentioned this pull request Sep 19, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hawkw hawkw hawkw approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@samscott89 @hawkw