From 4cb73cc7d014d9848c0e00531cbd9dcc561e4253 Mon Sep 17 00:00:00 2001 From: fleetingbytes <7075397+fleetingbytes@users.noreply.github.com> Date: Mon, 3 Apr 2023 19:30:20 +0200 Subject: [PATCH] Preserve potential mood for equal or NUL sign Original `var_os` description said that it _may_ return an error if the value contains `=` or NUL. Let's make no promises on the `None` return value in these situation either, keep it in the [potential mood](https://en.wikipedia.org/wiki/Grammatical_mood#Potential). --- library/std/src/env.rs | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/library/std/src/env.rs b/library/std/src/env.rs index 1345469d8b32..51e5c60ed294 100644 --- a/library/std/src/env.rs +++ b/library/std/src/env.rs @@ -236,11 +236,9 @@ fn _var(key: &OsStr) -> Result { } /// Fetches the environment variable `key` from the current process, returning -/// [`None`] in the following situations: -/// -/// - the environment variable isn't set -/// - the environment variable's name contains -/// the equal sign character (`=`) or the NUL character +/// [`None`] if the environment variable isn't set. It may return `None` also +/// 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 /// is valid Unicode. If you want to have an error on invalid UTF-8,