diff options
| -rw-r--r-- | library/std/src/env.rs | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/library/std/src/env.rs b/library/std/src/env.rs index 51e5c60ed29..74394694d43 100644 --- a/library/std/src/env.rs +++ b/library/std/src/env.rs @@ -236,11 +236,12 @@ fn _var(key: &OsStr) -> Result<String, VarError> { } /// Fetches the environment variable `key` from the current process, returning -/// [`None`] if the environment variable isn't set. It may return `None` also -/// if the environment variable's name contains +/// [`None`] if the variable isn't set or if there is another error. +/// +/// It may return `None` if the environment variable's name contains /// the equal sign character (`=`) or the NUL character. /// -/// Note that the method will not check if the environment variable +/// Note that this function will not check if the environment variable /// is valid Unicode. If you want to have an error on invalid UTF-8, /// use the [`var`] function instead. /// |