Skip to content

Commit

Permalink
Rollup merge of rust-lang#109894 - fleetingbytes:109893-var_os-never-…
Browse files Browse the repository at this point in the history
…returns-an-error, r=cuviper

Remove Errors section from var_os docs

Remove `Errors` section from `var_os` documentation, fixes rust-lang#109893
  • Loading branch information
compiler-errors authored Apr 12, 2023
2 parents 4a24aab + 7d26963 commit 8a7a665
Showing 1 changed file with 5 additions and 12 deletions.
17 changes: 5 additions & 12 deletions library/std/src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
///
Expand Down

0 comments on commit 8a7a665

Please sign in to comment.