Skip to content

Commit

Permalink
Break up long first paragraph
Browse files Browse the repository at this point in the history
Further referring to `var_os` as a "function" (like in `var`), rather than "method".
  • Loading branch information
fleetingbytes authored Apr 11, 2023
1 parent 4cb73cc commit 7d26963
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions library/std/src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -236,11 +236,12 @@ fn _var(key: &OsStr) -> Result<String, VarError> {
}

/// Fetches the environment variable `key` from the current process, returning
/// [`None`] if the environment variable isn't set. It may return `None` also
/// if the environment variable's name contains
/// [`None`] if the variable isn't set or if there is another error.
///
/// It may return `None` 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
/// 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.
///
Expand Down

0 comments on commit 7d26963

Please sign in to comment.