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

subcriber: update docs for EnvFilter Builder #2782

Merged
merged 3 commits into from
Oct 30, 2023

Conversation

nathanielc
Copy link
Contributor

The from_env and try_from_env method on the builder had the same documentation. This change updates their docs to correctly describe their difference in behavior.

Motivation

Make the docs more clear, so that users need not look at the source to understand the difference between these two functions.

Solution

Updated the docs

The from_env and try_from_env method on the builder had the same
documentation. This change updates their docs to correctly describe
their difference in behavior.
@nathanielc nathanielc requested review from hawkw, davidbarsky and a team as code owners October 30, 2023 15:05
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 docs fix, this is much clearer! i had a couple small suggestions

tracing-subscriber/src/filter/env/builder.rs Outdated Show resolved Hide resolved
tracing-subscriber/src/filter/env/builder.rs Show resolved Hide resolved
@hawkw hawkw enabled auto-merge (squash) October 30, 2023 16:03
@hawkw hawkw merged commit bfc8593 into tokio-rs:master Oct 30, 2023
55 checks passed
@nathanielc nathanielc deleted the docs/from_env branch October 30, 2023 18:06
davidbarsky pushed a commit that referenced this pull request Nov 7, 2023
The `from_env` and `try_from_env` methods on the builder had the same documentation. This change updates their docs to correctly describe their difference in behavior.


## Motivation

Make the docs more clear, so that users need not look at the source to understand the difference between these two functions.

## Solution

Updated the docs

Co-authored-by: Eliza Weisman <[email protected]>
hawkw added a commit that referenced this pull request Nov 7, 2023
The `from_env` and `try_from_env` methods on the builder had the same documentation. This change updates their docs to correctly describe their difference in behavior.


## Motivation

Make the docs more clear, so that users need not look at the source to understand the difference between these two functions.

## Solution

Updated the docs

Co-authored-by: Eliza Weisman <[email protected]>
kaffarell pushed a commit to kaffarell/tracing that referenced this pull request Nov 21, 2023
The `from_env` and `try_from_env` methods on the builder had the same documentation. This change updates their docs to correctly describe their difference in behavior.


## Motivation

Make the docs more clear, so that users need not look at the source to understand the difference between these two functions.

## Solution

Updated the docs

Co-authored-by: Eliza Weisman <[email protected]>
kaffarell pushed a commit to kaffarell/tracing that referenced this pull request Feb 14, 2024
The `from_env` and `try_from_env` methods on the builder had the same documentation. This change updates their docs to correctly describe their difference in behavior.


## Motivation

Make the docs more clear, so that users need not look at the source to understand the difference between these two functions.

## Solution

Updated the docs

Co-authored-by: Eliza Weisman <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants