about summary refs log tree commit diff
path: root/library/std/src
diff options
context:
space:
mode:
authorDylan DPC <dylan.dpc@gmail.com>2020-09-07 01:18:12 +0200
committerGitHub <noreply@github.com>2020-09-07 01:18:12 +0200
commit346d54d1f873fed53258835f489ce24d77591ec1 (patch)
tree66e4fc0671d4dd53886c43227de0fcc81b20f115 /library/std/src
parent1db9290a83985f3000aa3af6ccf529275e29be6e (diff)
parent85b11d50b28137b5dbd739af4c59aee94ace7617 (diff)
downloadrust-346d54d1f873fed53258835f489ce24d77591ec1.tar.gz
rust-346d54d1f873fed53258835f489ce24d77591ec1.zip
Rollup merge of #76344 - camelid:patch-6, r=KodrAus
Improve docs for `std::env::args()`

@rustbot modify labels: T-doc
Diffstat (limited to 'library/std/src')
-rw-r--r--library/std/src/env.rs12
1 files changed, 6 insertions, 6 deletions
diff --git a/library/std/src/env.rs b/library/std/src/env.rs
index 970dea6b299..b0fceb9b2f6 100644
--- a/library/std/src/env.rs
+++ b/library/std/src/env.rs
@@ -695,21 +695,21 @@ pub struct ArgsOs {
     inner: sys::args::Args,
 }
 
-/// Returns the arguments which this program was started with (normally passed
+/// Returns the arguments that this program was started with (normally passed
 /// via the command line).
 ///
 /// 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.
 ///
-/// On Unix systems shell usually expands unquoted arguments with glob patterns
+/// On Unix systems the shell usually expands unquoted arguments with glob patterns
 /// (such as `*` and `?`). On Windows this is not done, and such arguments are
 /// passed as-is.
 ///
-/// On glibc Linux systems, arguments are retrieved by placing a function in ".init_array".
-/// Glibc passes argc, argv, and envp to functions in ".init_array", as a non-standard extension.
-/// This allows `std::env::args` to work even in a `cdylib` or `staticlib`, as it does on macOS
-/// and Windows.
+/// On glibc Linux systems, arguments are retrieved by placing a function in `.init_array`.
+/// Glibc passes `argc`, `argv`, and `envp` to functions in `.init_array`, as a non-standard
+/// extension. This allows `std::env::args` to work even in a `cdylib` or `staticlib`, as it
+/// does on macOS and Windows.
 ///
 /// # Panics
 ///