Skip to content

Remove Errors section from var_os docs #109894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 12, 2023
Merged

Remove Errors section from var_os docs #109894

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9f1a3a1
Update env.rs
fleetingbytes Apr 3, 2023
c252f0d
add situation where var_os returns None
fleetingbytes Apr 3, 2023
5618c8e
remove self-reference in var_os doc
fleetingbytes Apr 3, 2023
a450557
Remove redundant empty line
fleetingbytes Apr 3, 2023
4cb73cc
Preserve potential mood for equal or NUL sign
fleetingbytes Apr 3, 2023
7d26963
Break up long first paragraph
fleetingbytes Apr 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 5 additions & 12 deletions library/std/src/env.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,21 +236,14 @@ fn _var(key: &OsStr) -> Result<String, VarError> {
}

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