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

fix env_logger crate name typo in lib.rs documentation #2769

Closed
wants to merge 1 commit into from

Conversation

smacdo
Copy link

@smacdo smacdo commented Oct 22, 2023

This fixes a small typo in the crate's module documentation that can mislead a first time user who is looking to use the env_logger module in tracing-log.

Motivation

A first time user following the crate.rs documentation will accidentally use env-logger as their feature flag, hit a compiler error and spend extra time trying to figure out the correct feature flag name.

Solution

Fix the typo by changing env-logger to env_logger.

This fixes a small typo in the crate's module documentation that can mislead a first time user who is looking to use the `env_logger` module in `tracing-log`.
@smacdo smacdo requested review from hawkw, davidbarsky and a team as code owners October 22, 2023 22:20
@davidbarsky
Copy link
Member

Thanks for opening this PR! You are correct to fix this, but there's a bit of unfortunate timing in that we're removing the env_logger logger feature entirely in #2772. For that reason, I'll close this PR.

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