nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-30 02:33:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #42579 - maccoda:maccoda/env_docs, r=steveklabnik

Browse Source 
env docs completion.

Should be closing #29351 with the alignment of the iterators to the template.
This commit is contained in:
Corey Farwell 2017-06-12 12:39:46 -04:00 committed by GitHub
commit 3a550a4893
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/libstd/env.rs
View File

@ -367,7 +367,7 @@ fn _remove_var(k: &OsStr) {
/// An iterator that splits an environment variable into paths according to
/// platform-specific conventions.
///
/// This structure is created by the [`std::env::split_paths`] function See its
/// This structure is created by the [`std::env::split_paths`] function. See its
/// documentation for more.
///
/// [`std::env::split_paths`]: fn.split_paths.html
@ -605,14 +605,15 @@ pub fn current_exe() -> io::Result<PathBuf> {
os_imp::current_exe()
}
/// An iterator over the arguments of a process, yielding a [`String`] value
/// for each argument.
/// An iterator over the arguments of a process, yielding a [`String`] value for
/// each argument.
///
/// This structure is created through the [`std::env::args`] function.
/// This struct is created by the [`std::env::args`] function. 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.
/// set to arbitrary text, and may not even exist. This means this property
/// should not be relied upon for security purposes.
///
/// [`String`]: ../string/struct.String.html
/// [`std::env::args`]: ./fn.args.html
@ -622,11 +623,12 @@ pub struct Args { inner: ArgsOs }
/// An iterator over the arguments of a process, yielding an [`OsString`] value
/// for each argument.
///
/// This structure is created through the [`std::env::args_os`] function.
/// This struct is created by the [`std::env::args_os`] function. 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.
/// set to arbitrary text, and may not even exist. This means this property
/// should not be relied upon for security purposes.
///
/// [`OsString`]: ../ffi/struct.OsString.html
/// [`std::env::args_os`]: ./fn.args_os.html