code review improvements

This commit is contained in:
Evan Jones 2024-08-18 10:43:36 -04:00
parent d5a7c45966
commit b0023f5a41

View File

@ -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
///