From d9752c7d843f3f93ed7f570b072aec8eb5127a96 Mon Sep 17 00:00:00 2001
From: Aris Merchant <22333129+inquisitivecrystal@users.noreply.github.com>
Date: Mon, 5 Jul 2021 22:12:48 -0700
Subject: [PATCH] Improve env var getter docs

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

diff --git a/library/std/src/env.rs b/library/std/src/env.rs
index a7b27486811..a359ad3b558 100644
--- a/library/std/src/env.rs
+++ b/library/std/src/env.rs
@@ -185,11 +185,9 @@ impl fmt::Debug for VarsOs {
 ///
 /// # Errors
 ///
-/// Errors if the environment variable is not present.
-/// Errors if the environment variable is not valid Unicode. If this is not desired, consider using
-/// [`var_os`].
-/// May error if the `key` is empty, contains an ASCII equals sign `'='`, or contains the NUL character `'\0'`.
-/// May error when the value contains the NUL character.
+/// 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`].
 ///
 /// # Examples
 ///
@@ -223,9 +221,8 @@ fn _var(key: &OsStr) -> Result<String, VarError> {
 ///
 /// # Errors
 ///
-/// Errors if the variable isn't set.
-/// May error if the `key` is empty, contains an ASCII equals sign `'='`, or contains the NUL character `'\0'`.
-/// May error when the value contains the NUL character.
+/// Returns `[None]` if the variable isn't set.
+/// May return `[None]` if the variable value contains the NUL character.
 ///
 /// # Examples
 ///