Skip to content

/log

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

Added links to logging frameworks #188

Merged
merged 1 commit into from Jun 2, 2017

Conversation

Reviewers

@dtolnay dtolnay

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@budziq @dtolnay
@budziq
Copy link
Contributor

budziq commented Jun 2, 2017 •
edited

solves #115

  • I've left env_logger on the list as the most popular implementation (as it is to be separated from main log repo it should not be penalized)
  • I've chosen links to docs.rs over crates.io. But I do not have strong preference
  • the "simple" section was a little crowded so I've pruned the least popular crates but sadly it has left us with simple_logger and pretty_env_logger which do not provide nice docs

I am eager hear any suggestions.
@dtolnay

dtolnay reviewed Jun 2, 2017
View changes

src/lib.rs Outdated
@@ -208,6 +229,16 @@
//! [`MaxLevelFilter`]: struct.MaxLevelFilter.html
//! [`set_logger_raw`]: fn.set_logger_raw.html
//! [`shutdown_logger_raw`]: fn.shutdown_logger_raw.html
//! [env_logger]: https://docs.rs/env_logger/*/env_logger/
//! [simple_logger]: https://docs.rs/simple_logger/*/simple_logger/

This comment has been minimized.

Sign in to view
Copy link
@dtolnay

dtolnay Jun 2, 2017

Member

https://github.com/borntyping/rust-simple_logger would be a better landing page.
src/lib.rs Outdated
@@ -92,6 +92,27 @@
//! }
//! ```
//!
//! # Available logging frameworks
//!
//! In order to produce log output executables have to utilize

This comment has been minimized.

Sign in to view
Copy link
@dtolnay

dtolnay Jun 2, 2017

Member

"Utilize" is not the right word. See https://english.stackexchange.com/questions/143941/when-to-use-use-and-when-to-use-utilize-in-a-sentence/.

This comment has been minimized.

Sign in to view
Copy link
@budziq

budziq Jun 2, 2017

Author Contributor

Huh who would know? Thanks!
src/lib.rs Outdated
@@ -208,6 +229,16 @@
//! [`MaxLevelFilter`]: struct.MaxLevelFilter.html
//! [`set_logger_raw`]: fn.set_logger_raw.html
//! [`shutdown_logger_raw`]: fn.shutdown_logger_raw.html
//! [env_logger]: https://docs.rs/env_logger/*/env_logger/
//! [simple_logger]: https://docs.rs/simple_logger/*/simple_logger/
//! [simplelog]: https://docs.rs/simplelog/*/simplelog/

This comment has been minimized.

Sign in to view
Copy link
@dtolnay

dtolnay Jun 2, 2017

Member

https://github.com/drakulix/simplelog.rs would be a better landing page.
src/lib.rs Outdated
//! * [env_logger]
//! * [simple_logger]
//! * [simplelog]
//! * [pretty_env_logger]

This comment has been minimized.

Sign in to view
Copy link
@dtolnay

dtolnay Jun 2, 2017

Member

Please remove this from the list for now and file an issue asking the author to add documentation. As is, it doesn't seem intended for people to use.

This comment has been minimized.

Sign in to view
Copy link
@budziq

budziq Jun 2, 2017

Author Contributor

Filed an issue against the repo seanmonstar/pretty-env-logger#2 already got positive response from the author :)
src/lib.rs Outdated
//! # Available logging frameworks
//!
//! In order to produce log output executables have to utilize
//! a framework compatible with the facade.

This comment has been minimized.

Sign in to view
Copy link
@dtolnay

dtolnay Jun 2, 2017

Member

Almost none of these are a "framework." Maybe only log4rs. Something like env_logger is definitely not a "framework." I think above it refers to these using the word "implementation."

The log crate provides a single logging API that abstracts over the actual logging implementation.

This comment has been minimized.

Sign in to view
Copy link
@budziq

budziq Jun 2, 2017

Author Contributor

I was quite at loss in regard to wording as https://docs.rs/log/0.3.8/log/ landing page most refers to "implementations" as "frameworks" I agree that my wording was amiss.

@dtolnay Maybe rest of the docs should be updated to tone down the "framework" wording?

This comment has been minimized.

Sign in to view
Copy link
@dtolnay

dtolnay Jun 2, 2017

Member

Thanks, I didn't notice how pervasive it is in the existing documentation. I filed #191 to follow up.
@budziq

budziq reviewed Jun 2, 2017
View changes

Copy link
Contributor Author

budziq left a comment

Thanks for great review!
src/lib.rs Outdated
//! * [env_logger]
//! * [simple_logger]
//! * [simplelog]
//! * [pretty_env_logger]

This comment has been minimized.

Sign in to view
Copy link
@budziq

budziq Jun 2, 2017

Author Contributor

Filed an issue against the repo seanmonstar/pretty-env-logger#2 already got positive response from the author :)
src/lib.rs Outdated
@@ -92,6 +92,27 @@
//! }
//! ```
//!
//! # Available logging frameworks
//!
//! In order to produce log output executables have to utilize

This comment has been minimized.

Sign in to view
Copy link
@budziq

budziq Jun 2, 2017

Author Contributor

Huh who would know? Thanks!
src/lib.rs Outdated
//! # Available logging frameworks
//!
//! In order to produce log output executables have to utilize
//! a framework compatible with the facade.

This comment has been minimized.

Sign in to view
Copy link
@budziq

budziq Jun 2, 2017

Author Contributor

I was quite at loss in regard to wording as https://docs.rs/log/0.3.8/log/ landing page most refers to "implementations" as "frameworks" I agree that my wording was amiss.

@dtolnay Maybe rest of the docs should be updated to tone down the "framework" wording?

@budziq budziq force-pushed the budziq:sinks_docs branch from dbd3c44 to 969107c Jun 2, 2017

@budziq

This comment has been minimized.

Sign in to view
Copy link
Contributor Author

budziq commented Jun 2, 2017 •
edited

Done. Thanks for your time!

Also updated the wording on following heading from "Logger Implementation" to "Implementing a Logger" to avoid weird stuttering between sections

@dtolnay dtolnay merged commit 255cf72 into rust-lang-nursery:master Jun 2, 2017
2 checks passed

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@dtolnay dtolnay referenced this pull request Jun 2, 2017

Closed

Link to logging sinks other than env_logger in the README/crate docs #115

@budziq budziq deleted the budziq:sinks_docs branch Jun 27, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.