Skip to content

Commit

Permalink
code review improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
evanj committed Aug 18, 2024
1 parent 9668691 commit 23b0aad
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions std/src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -198,16 +198,12 @@ impl fmt::Debug for VarsOs {
///
/// # Errors
///
/// This function returns [`VarError::NotPresent`] if the environment variable
/// isn't set.
/// Returns [`VarError::NotPresent`] if:
/// - The variable is not set.
/// - The variable's name contains an equal sign or NUL (`'='` or `'\0'`).
///
/// This function may return [`VarError::NotPresent`] if the
/// environment variable's name contains the equal sign character (`=`) or the
/// NUL character.
///
/// This function will return [`VarError::NotUnicode`] if the environment
/// variable's value is not valid Unicode. If this is not desired, consider
/// using [`var_os`].
/// Returns [`VarError::NotUnicode`] if the variable's value is not valid
/// Unicode. If this is not desired, consider using [`var_os`].
///
/// # Examples
///
Expand Down

0 comments on commit 23b0aad

Please sign in to comment.