From f52ac18840d29c93881b0d3ea100dcf4e55348dd Mon Sep 17 00:00:00 2001 From: Dylan Maccora Date: Sat, 10 Jun 2017 16:19:28 +1000 Subject: [PATCH] env docs completion. --- src/libstd/env.rs | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/src/libstd/env.rs b/src/libstd/env.rs index 5d2bb9daf17ef..4bb0f26014c07 100644 --- a/src/libstd/env.rs +++ b/src/libstd/env.rs @@ -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 { 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