OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

clarify docs for Args and ArgsOs

Browse Source 
The args() and args_os() docs include a line about how the first element
is usually the program name. Include that line in the struct docs too.
This commit is contained in:
Jack O'Connor 2017-03-05 16:39:24 -05:00
parent 6b76c9ea19
commit 03b83a01ad
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/libstd/env.rs
View File

@ -590,6 +590,10 @@ pub fn current_exe() -> io::Result<PathBuf> {
///
/// This structure is created through the [`std::env::args`] function.
///
/// 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.
///
/// [`String`]: ../string/struct.String.html
/// [`std::env::args`]: ./fn.args.html
#[stable(feature = "env", since = "1.0.0")]
@ -600,6 +604,10 @@ pub struct Args { inner: ArgsOs }
///
/// This structure is created through the [`std::env::args_os`] function.
///
/// 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.
///
/// [`OsString`]: ../ffi/struct.OsString.html
/// [`std::env::args_os`]: ./fn.args_os.html
#[stable(feature = "env", since = "1.0.0")]