Skip to content

Commit 1908978

Browse files
authored
prepare for 0.5.0 release (#54)
1 parent f7abf9c commit 1908978

4 files changed

Lines changed: 14 additions & 15 deletions

File tree

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "env_logger"
3-
version = "0.5.0-rc.2" # remember to update html_root_url
3+
version = "0.5.0" # remember to update html_root_url
44
authors = ["The Rust Project Developers"]
55
license = "MIT/Apache-2.0"
66
readme = "README.md"

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ It must be added along with `log` to the project dependencies:
1818
```toml
1919
[dependencies]
2020
log = "0.4.0"
21-
env_logger = "0.5.0-rc.2"
21+
env_logger = "0.5.0"
2222
```
2323

2424
`env_logger` must be initialized as early as possible in the project. After it's initialized, you can use the `log` macros to do actual logging.
@@ -54,7 +54,7 @@ Tests can use the `env_logger` crate to see log messages generated during that t
5454
log = "0.4.0"
5555

5656
[dev-dependencies]
57-
env_logger = "0.5.0-rc.2"
57+
env_logger = "0.5.0"
5858
```
5959

6060
```rust

src/fmt.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
//!
88
//! # Formatting log records
99
//!
10-
//! The format used to print log records can be customised using the [`Builder.format`]
10+
//! The format used to print log records can be customised using the [`Builder::format`]
1111
//! method.
1212
//! Custom formats can apply different color and weight to printed values using
1313
//! [`Style`] builders.
@@ -31,7 +31,7 @@
3131
//!
3232
//! [`Formatter`]: struct.Formatter.html
3333
//! [`Style`]: struct.Style.html
34-
//! [`Builder.format`]: ../struct.Builder.html#method.format
34+
//! [`Builder::format`]: ../struct.Builder.html#method.format
3535
//! [`Write`]: https://doc.rust-lang.org/stable/std/io/trait.Write.html
3636
3737
use std::io::prelude::*;
@@ -72,7 +72,7 @@ pub struct Formatter {
7272

7373
/// A set of styles to apply to the terminal output.
7474
///
75-
/// Call [`Formatter.style`] to get a `Style` and use the builder methods to
75+
/// Call [`Formatter::style`] to get a `Style` and use the builder methods to
7676
/// set styling properties, like [color] and [weight].
7777
/// To print a value using the style, wrap it in a call to [`value`] when the log
7878
/// record is formatted.
@@ -118,9 +118,9 @@ pub struct Formatter {
118118
/// });
119119
/// ```
120120
///
121-
/// [`Formatter.style`]: struct.Formatter.html#method.style
122-
/// [color]: #method.color
123-
/// [weight]: #method.weight
121+
/// [`Formatter::style`]: struct.Formatter.html#method.style
122+
/// [color]: #method.set_color
123+
/// [weight]: #method.set_bold
124124
/// [`value`]: #method.value
125125
#[derive(Clone)]
126126
pub struct Style {
@@ -130,9 +130,9 @@ pub struct Style {
130130

131131
/// A value that can be printed using the given styles.
132132
///
133-
/// It is the result of calling [`Style.value`].
133+
/// It is the result of calling [`Style::value`].
134134
///
135-
/// [`Style.value`]: struct.Style.html#method.value
135+
/// [`Style::value`]: struct.Style.html#method.value
136136
pub struct StyledValue<'a, T> {
137137
style: &'a Style,
138138
value: T,

src/lib.rs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@
142142
143143
#![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
144144
html_favicon_url = "http://www.rust-lang.org/favicon.ico",
145-
html_root_url = "https://docs.rs/env_logger/0.5.0-rc.2")]
145+
html_root_url = "https://docs.rs/env_logger/0.5.0")]
146146
#![cfg_attr(test, deny(warnings))]
147147

148148
// When compiled for the rustc compiler itself we want to make sure that this is
@@ -197,15 +197,14 @@ pub struct Env<'a> {
197197
/// default global logger.
198198
///
199199
/// If you'd instead need access to the constructed `Logger`, you can use
200-
/// [`Logger::new()`] or the associated [`Builder`] and install it with the
200+
/// the associated [`Builder`] and install it with the
201201
/// [`log` crate][log-crate-url] directly.
202202
///
203203
/// [log-crate-url]: https://docs.rs/log/
204204
/// [`init()`]: fn.init.html
205205
/// [`try_init()`]: fn.try_init.html
206206
/// [`Builder::init()`]: struct.Builder.html#method.init
207207
/// [`Builder::try_init()`]: struct.Builder.html#method.try_init
208-
/// [`Logger::new()`]: #method.new
209208
/// [`Builder`]: struct.Builder.html
210209
pub struct Logger {
211210
writer: fmt::Writer,
@@ -347,7 +346,7 @@ impl Builder {
347346
/// to format and output without intermediate heap allocations. The default
348347
/// `env_logger` formatter takes advantage of this.
349348
///
350-
/// [`Formatter`]: struct.Formatter.html
349+
/// [`Formatter`]: fmt/struct.Formatter.html
351350
/// [`String`]: https://doc.rust-lang.org/stable/std/string/struct.String.html
352351
/// [`std::fmt`]: https://doc.rust-lang.org/std/fmt/index.html
353352
pub fn format<F: 'static>(&mut self, format: F) -> &mut Self

0 commit comments

Comments
 (0)