about summary refs log tree commit diff
diff options
context:
space:
mode:
authorÉrico Nogueira Rolim <34201958+ericonr@users.noreply.github.com>2021-07-23 02:32:55 -0300
committerÉrico Nogueira <erico.erc@gmail.com>2021-07-23 17:20:45 -0300
commit74f01a4bbe441816aa5de489ca87f77d3474af37 (patch)
tree6d3abed39769b1fb7ea11faaab0e8c0d367af4a1
parent027187094ee05011d6602f5742f550851ccc7fd6 (diff)
downloadrust-74f01a4bbe441816aa5de489ca87f77d3474af37.tar.gz
rust-74f01a4bbe441816aa5de489ca87f77d3474af37.zip
Fix parameter names in std::env documentation.
The function parameters were renamed, but the documentation wasn't.
-rw-r--r--library/std/src/env.rs7
1 files changed, 3 insertions, 4 deletions
diff --git a/library/std/src/env.rs b/library/std/src/env.rs
index 64f88c1aba6..5709d97d643 100644
--- a/library/std/src/env.rs
+++ b/library/std/src/env.rs
@@ -294,7 +294,7 @@ impl Error for VarError {
     }
 }
 
-/// Sets the environment variable `k` to the value `v` for the currently running
+/// Sets the environment variable `key` to the value `value` for the currently running
 /// process.
 ///
 /// Note that while concurrent access to environment variables is safe in Rust,
@@ -310,9 +310,8 @@ impl Error for VarError {
 ///
 /// # Panics
 ///
-/// This function may panic if `key` is empty, contains an ASCII equals sign
-/// `'='` or the NUL character `'\0'`, or when the value contains the NUL
-/// character.
+/// This function may panic if `key` is empty, contains an ASCII equals sign `'='`
+/// or the NUL character `'\0'`, or when `value` contains the NUL character.
 ///
 /// # Examples
 ///