diff options
| author | Michael Goulet <michael@errs.io> | 2023-04-11 20:28:46 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-11 20:28:46 -0700 |
| commit | 8a7a66572e85461ccfe7307ed3c554e88d40fb0c (patch) | |
| tree | 5fc38c0754f178189e0b6b092c5c66e438aeadb1 | |
| parent | 4a24aab22019509294aecb1e339fed95662a8c29 (diff) | |
| parent | 7d269633b1e254ad21f23994bbf04a6a8296abf7 (diff) | |
| download | rust-8a7a66572e85461ccfe7307ed3c554e88d40fb0c.tar.gz rust-8a7a66572e85461ccfe7307ed3c554e88d40fb0c.zip | |
Rollup merge of #109894 - fleetingbytes:109893-var_os-never-returns-an-error, r=cuviper
Remove Errors section from var_os docs Remove `Errors` section from `var_os` documentation, fixes #109893
| -rw-r--r-- | library/std/src/env.rs | 17 |
1 files changed, 5 insertions, 12 deletions
diff --git a/library/std/src/env.rs b/library/std/src/env.rs index 3014fe6e2fc..d372fa64065 100644 --- a/library/std/src/env.rs +++ b/library/std/src/env.rs @@ -236,21 +236,14 @@ fn _var(key: &OsStr) -> Result<String, VarError> { } /// Fetches the environment variable `key` from the current process, returning -/// [`None`] if the variable isn't set or there's another error. +/// [`None`] if the variable isn't set or if there is another error. /// -/// 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, -/// use the [`var`] function instead. -/// -/// # Errors -/// -/// 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 +/// It may return `None` 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. +/// 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. /// /// # Examples /// |
