Skip to content

Commit 2b029aa

Browse files
committed
Clarify language around method order.
1 parent 7204332 commit 2b029aa

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

src/lib.rs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,10 @@ impl SimpleLogger {
146146
/// Simulates env_logger behavior, which enables the user to choose log
147147
/// level by setting a `RUST_LOG` environment variable. This will use
148148
/// the default level set by [`with_level`] if `RUST_LOG` is not set or
149-
/// can't be parsed as a standard log level.
150-
/// (if calling `with_level`, call this after that, otherwise it will have no effect)
149+
/// can't be parsed as a standard log level.
150+
///
151+
/// This must be called after [`with_level`]. If called before
152+
/// [`with_level`], it will have no effect.
151153
///
152154
/// [`with_level`]: #method.with_level
153155
#[must_use = "You must call init() to begin logging"]
@@ -166,6 +168,9 @@ impl SimpleLogger {
166168
///
167169
/// You can override the default level for specific modules and their sub-modules using [`with_module_level`]
168170
///
171+
/// This must be called before [`env`]. If called after [`env`], it will override the value loaded from the environment.
172+
///
173+
/// [`env`]: #method.env
169174
/// [`with_module_level`]: #method.with_module_level
170175
#[must_use = "You must call init() to begin logging"]
171176
pub fn with_level(mut self, level: LevelFilter) -> SimpleLogger {

0 commit comments

Comments
 (0)