Skip to content

Commit

Permalink
Rollup merge of #95646 - mgeisler:mention-std-env-var, r=Dylan-DPC
Browse files Browse the repository at this point in the history
Mention `std::env::var` in `env!`

When searching for how to read an environment variable, I first encountered the `env!` macro. It would have been useful to me if the documentation had included a link to `std::env::var`, which is what I was actually looking for.
  • Loading branch information
Dylan-DPC authored Apr 7, 2022
2 parents f7499a8 + 4f08d75 commit a2df05d
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions library/core/src/macros/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -909,7 +909,10 @@ pub(crate) mod builtin {
/// Inspects an environment variable at compile time.
///
/// This macro will expand to the value of the named environment variable at
/// compile time, yielding an expression of type `&'static str`.
/// compile time, yielding an expression of type `&'static str`. Use
/// [`std::env::var`] instead if you want to read the value at runtime.
///
/// [`std::env::var`]: ../std/env/fn.var.html
///
/// If the environment variable is not defined, then a compilation error
/// will be emitted. To not emit a compile error, use the [`option_env!`]
Expand Down Expand Up @@ -950,7 +953,10 @@ pub(crate) mod builtin {
/// expand into an expression of type `Option<&'static str>` whose value is
/// `Some` of the value of the environment variable. If the environment
/// variable is not present, then this will expand to `None`. See
/// [`Option<T>`][Option] for more information on this type.
/// [`Option<T>`][Option] for more information on this type. Use
/// [`std::env::var`] instead if you want to read the value at runtime.
///
/// [`std::env::var`]: ../std/env/fn.var.html
///
/// A compile time error is never emitted when using this macro regardless
/// of whether the environment variable is present or not.
Expand Down

0 comments on commit a2df05d

Please sign in to comment.