From b0023f5a417374aad980422b3f437f133676d4ef Mon Sep 17 00:00:00 2001
From: Evan Jones <ej@evanjones.ca>
Date: Sun, 18 Aug 2024 10:43:36 -0400
Subject: [PATCH] code review improvements

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

diff --git a/library/std/src/env.rs b/library/std/src/env.rs
index 215b7b03f04c3..bbe191181c5a8 100644
--- a/library/std/src/env.rs
+++ b/library/std/src/env.rs
@@ -198,16 +198,12 @@ impl fmt::Debug for VarsOs {
 ///
 /// # Errors
 ///
-/// This function returns [`VarError::NotPresent`] if the environment variable
-/// isn't set.
+/// Returns [`VarError::NotPresent`] if:
+/// - The variable is not set.
+/// - The variable's name contains an equal sign or NUL (`'='` or `'\0'`).
 ///
-/// This function may return [`VarError::NotPresent`] if the
-/// environment variable's name contains the equal sign character (`=`) or the
-/// NUL character.
-///
-/// This function will return [`VarError::NotUnicode`] if the environment
-/// variable's value is not valid Unicode. If this is not desired, consider
-/// using [`var_os`].
+/// Returns [`VarError::NotUnicode`] if the variable's value is not valid
+/// Unicode. If this is not desired, consider using [`var_os`].
 ///
 /// # Examples
 ///