From fdf09130dfb99fc52c1e6ecad6cc9158c65ef08e Mon Sep 17 00:00:00 2001
From: inquisitivecrystal
 <22333129+inquisitivecrystal@users.noreply.github.com>
Date: Tue, 17 Aug 2021 00:09:58 -0700
Subject: [PATCH] Fix environment variable getter docs

---
 library/std/src/env.rs | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

diff --git a/library/std/src/env.rs b/library/std/src/env.rs
index f9f14d0dc63b4..a746520095559 100644
--- a/library/std/src/env.rs
+++ b/library/std/src/env.rs
@@ -185,9 +185,13 @@ impl fmt::Debug for VarsOs {
 ///
 /// # Errors
 ///
-/// Returns `[None]` if the environment variable isn't set.
-/// Returns `[None]` if the environment variable is not valid Unicode. If this is not
-/// desired, consider using [`var_os`].
+/// This function will return an error if the environment variable isn't set.
+///
+/// This function may return an error if the environment variable's name contains
+/// the equal sign character (`=`) or the NUL character.
+///
+/// This function will return an error if the environment variable's value is
+/// not valid Unicode. If this is not desired, consider using [`var_os`].
 ///
 /// # Examples
 ///
@@ -221,8 +225,13 @@ fn _var(key: &OsStr) -> Result<String, VarError> {
 ///
 /// # Errors
 ///
-/// Returns `[None]` if the variable isn't set.
-/// May return `[None]` if the variable value contains the NUL character.
+/// This function returns an error if the environment variable isn't set.
+///
+/// This function may return an error if the environment variable's name contains
+/// the equal sign character (`=`) or the NUL character.
+///
+/// This function may return an error if the environment variable's value contains
+/// the NUL character.
 ///
 /// # Examples
 ///