Skip to content

Commit

Permalink
Rollup merge of rust-lang#88109 - inquisitivecrystal:env-docs, r=m-ou-se
Browse files Browse the repository at this point in the history
Fix environment variable getter docs

`@RalfJung` pointed out a number of errors and suboptimal choices I made in my documentation for rust-lang#86183. This PR should (hopefully) fix the problems they've identified.
  • Loading branch information
GuillaumeGomez committed Aug 18, 2021
2 parents fe025a7 + fdf0913 commit fbaa4a2
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions library/std/src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,13 @@ impl fmt::Debug for VarsOs {
///
/// # Errors
///
/// 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`].
/// This function will return an error if the environment variable isn't set.
///
/// This function may return an error if the environment variable's name contains
/// the equal sign character (`=`) or the NUL character.
///
/// This function will return an error if the environment variable's value is
/// not valid Unicode. If this is not desired, consider using [`var_os`].
///
/// # Examples
///
Expand Down Expand Up @@ -221,8 +225,13 @@ fn _var(key: &OsStr) -> Result<String, VarError> {
///
/// # Errors
///
/// Returns `[None]` if the variable isn't set.
/// May return `[None]` if the variable value contains the NUL character.
/// 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
/// the equal sign character (`=`) or the NUL character.
///
/// This function may return an error if the environment variable's value contains
/// the NUL character.
///
/// # Examples
///
Expand Down

0 comments on commit fbaa4a2

Please sign in to comment.