dnrops
/
rust
mirror of https://github.com/rust-lang/rust.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #75945 - pickfire:patch-7, r=jyn514 

Use `env::func()`, not 'the function env::func' in docs for std::env

Follow up of https://github.com/rust-lang/rust/pull/75629

r? @jyn514
This commit is contained in:
Tyler Mandry 2020-08-31 19:18:13 -07:00 committed by GitHub
parent d824b23514 1d017eb6a4
commit b675824493
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
library/std/src/env.rs
View File

@ -68,10 +68,9 @@ pub fn set_current_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
/// An iterator over a snapshot of the environment variables of this process.
///
/// This structure is created by the [`std::env::vars`] function. See its
/// documentation for more.
/// This structure is created by [`env::vars()`]. See its documentation for more.
///
/// [`std::env::vars`]: vars
/// [`env::vars()`]: vars
#[stable(feature = "env", since = "1.0.0")]
pub struct Vars {
inner: VarsOs,
@ -79,10 +78,9 @@ pub struct Vars {
/// An iterator over a snapshot of the environment variables of this process.
///
/// This structure is created by the [`std::env::vars_os`] function. See
/// its documentation for more.
/// This structure is created by [`env::vars_os()`]. See its documentation for more.
///
/// [`std::env::vars_os`]: vars_os
/// [`env::vars_os()`]: vars_os
#[stable(feature = "env", since = "1.0.0")]
pub struct VarsOs {
inner: os_imp::Env,
@ -98,10 +96,8 @@ pub struct VarsOs {
/// # Panics
///
/// While iterating, the returned iterator will panic if any key or value in the
/// environment is not valid unicode. If this is not desired, consider using the
/// [`env::vars_os`] function.
///
/// [`env::vars_os`]: vars_os
/// environment is not valid unicode. If this is not desired, consider using
/// [`env::vars_os()`].
///
/// # Examples
///
@ -114,6 +110,8 @@ pub struct VarsOs {
/// println!("{}: {}", key, value);
/// }
/// ```
///
/// [`env::vars_os()`]: vars_os
#[stable(feature = "env", since = "1.0.0")]
pub fn vars() -> Vars {
Vars { inner: vars_os() }
@ -245,9 +243,9 @@ fn _var_os(key: &OsStr) -> Option<OsString> {
}
/// The error type for operations interacting with environment variables.
/// Possibly returned from the [`env::var`] function.
/// Possibly returned from [`env::var()`].
///
/// [`env::var`]: var
/// [`env::var()`]: var
#[derive(Debug, PartialEq, Eq, Clone)]
#[stable(feature = "env", since = "1.0.0")]
pub enum VarError {
@ -372,10 +370,10 @@ fn _remove_var(k: &OsStr) {
///
/// The iterator element type is [`PathBuf`].
///
/// This structure is created by the [`std::env::split_paths`] function. See its
/// This structure is created by [`env::split_paths()`]. See its
/// documentation for more.
///
/// [`std::env::split_paths`]: split_paths
/// [`env::split_paths()`]: split_paths
#[stable(feature = "env", since = "1.0.0")]
pub struct SplitPaths<'a> {
inner: os_imp::SplitPaths<'a>,
@ -426,9 +424,9 @@ impl fmt::Debug for SplitPaths<'_> {
}
/// The error type for operations on the `PATH` variable. Possibly returned from
/// the [`env::join_paths`] function.
/// [`env::join_paths()`].
///
/// [`env::join_paths`]: join_paths
/// [`env::join_paths()`]: join_paths
#[derive(Debug)]
#[stable(feature = "env", since = "1.0.0")]
pub struct JoinPathsError {
@ -463,7 +461,8 @@ pub struct JoinPathsError {
/// }
/// ```
///
/// Joining a path containing a colon on a Unix-like platform results in an error:
/// Joining a path containing a colon on a Unix-like platform results in an
/// error:
///
/// ```
/// # if cfg!(unix) {
@ -475,8 +474,8 @@ pub struct JoinPathsError {
/// # }
/// ```
///
/// Using `env::join_paths` with [`env::split_paths`] to append an item to the `PATH` environment
/// variable:
/// Using `env::join_paths()` with [`env::split_paths()`] to append an item to
/// the `PATH` environment variable:
///
/// ```
/// use std::env;
@ -494,7 +493,7 @@ pub struct JoinPathsError {
/// }
/// ```
///
/// [`env::split_paths`]: split_paths
/// [`env::split_paths()`]: split_paths
#[stable(feature = "env", since = "1.0.0")]
pub fn join_paths<I, T>(paths: I) -> Result<OsString, JoinPathsError>
where
@ -667,14 +666,14 @@ pub fn current_exe() -> io::Result<PathBuf> {
/// An iterator over the arguments of a process, yielding a [`String`] value for
/// each argument.
///
/// This struct is created by the [`std::env::args`] function. See its
/// documentation for more.
/// This struct is created by [`env::args()`]. See its documentation
/// for more.
///
/// The first element is traditionally the path of the executable, but it can be
/// set to arbitrary text, and may not even exist. This means this property
/// should not be relied upon for security purposes.
///
/// [`std::env::args`]: args
/// [`env::args()`]: args
#[stable(feature = "env", since = "1.0.0")]
pub struct Args {
inner: ArgsOs,
@ -683,14 +682,14 @@ pub struct Args {
/// An iterator over the arguments of a process, yielding an [`OsString`] value
/// for each argument.
///
/// This struct is created by the [`std::env::args_os`] function. See its
/// documentation for more.
/// This struct is created by [`env::args_os()`]. See its documentation
/// for more.
///
/// The first element is traditionally the path of the executable, but it can be
/// set to arbitrary text, and may not even exist. This means this property
/// should not be relied upon for security purposes.
///
/// [`std::env::args_os`]: args_os
/// [`env::args_os()`]: args_os
#[stable(feature = "env", since = "1.0.0")]
pub struct ArgsOs {
inner: sys::args::Args,