From 03b83a01add2167d81b57ff137359ec382d4dcf5 Mon Sep 17 00:00:00 2001 From: Jack O'Connor Date: Sun, 5 Mar 2017 16:39:24 -0500 Subject: [PATCH] clarify docs for Args and ArgsOs 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. --- src/libstd/env.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/libstd/env.rs b/src/libstd/env.rs index dd4f1ff4f5e..64eb52e28bc 100644 --- a/src/libstd/env.rs +++ b/src/libstd/env.rs @@ -590,6 +590,10 @@ pub fn current_exe() -> io::Result { /// /// 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")] -- 2.44.0