about summary refs log tree commit diff
path: root/library/std/src/env.rs
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2025-03-07 22:00:36 +0100
committerGuillaume Gomez <guillaume1.gomez@gmail.com>2025-03-07 22:00:36 +0100
commit17dd2b179c4fab87975bb1c23ea2b869ca516ea5 (patch)
tree55b327ae2f234e7d6bd38b4fc41baa483a1e5b57 /library/std/src/env.rs
parent91a0e1604f343730022bc903cbf201d8b0a86a71 (diff)
downloadrust-17dd2b179c4fab87975bb1c23ea2b869ca516ea5.tar.gz
rust-17dd2b179c4fab87975bb1c23ea2b869ca516ea5.zip
Mention `env` and `option_env` macros in `std::env::var` docs
Diffstat (limited to 'library/std/src/env.rs')
-rw-r--r--library/std/src/env.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/library/std/src/env.rs b/library/std/src/env.rs
index e62aeb2ede0..6961fa8ea94 100644
--- a/library/std/src/env.rs
+++ b/library/std/src/env.rs
@@ -202,6 +202,9 @@ impl fmt::Debug for VarsOs {
 /// Returns [`VarError::NotUnicode`] if the variable's value is not valid
 /// Unicode. If this is not desired, consider using [`var_os`].
 ///
+/// Use [`env!`] or [`option_env!`] instead if you want to check environment
+/// variables at compile time.
+///
 /// # Examples
 ///
 /// ```