Skip to content

Commit

Permalink
Improve env var getter docs
Browse files Browse the repository at this point in the history
  • Loading branch information
inquisitivecrystal committed Jul 6, 2021
1 parent a12107a commit d9752c7
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions library/std/src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -185,11 +185,9 @@ impl fmt::Debug for VarsOs {
///
/// # Errors
///
/// Errors if the environment variable is not present.
/// Errors if the environment variable is not valid Unicode. If this is not desired, consider using
/// [`var_os`].
/// May error if the `key` is empty, contains an ASCII equals sign `'='`, or contains the NUL character `'\0'`.
/// May error when the value contains the NUL character.
/// Returns `[None]` if the environment variable isn't set.
/// Returns `[None]` if the environment variable is not valid Unicode. If this is not
/// desired, consider using [`var_os`].
///
/// # Examples
///
Expand Down Expand Up @@ -223,9 +221,8 @@ fn _var(key: &OsStr) -> Result<String, VarError> {
///
/// # Errors
///
/// Errors if the variable isn't set.
/// May error if the `key` is empty, contains an ASCII equals sign `'='`, or contains the NUL character `'\0'`.
/// May error when the value contains the NUL character.
/// Returns `[None]` if the variable isn't set.
/// May return `[None]` if the variable value contains the NUL character.
///
/// # Examples
///
Expand Down

0 comments on commit d9752c7

Please sign in to comment.