about summary refs log tree commit diff
diff options
context:
space:
mode:
authorTim <tdhutt@gmail.com>2022-10-03 17:27:13 +0100
committerGitHub <noreply@github.com>2022-10-03 17:27:13 +0100
commit8f0025e5a3346b1cfcc64abca7bf768f25d1ff9e (patch)
tree16cbd708e1dfbc996170e86371c828372a3ad040
parent8d08983c2b14e5277580015006e334104cbbd7d1 (diff)
downloadrust-8f0025e5a3346b1cfcc64abca7bf768f25d1ff9e.tar.gz
rust-8f0025e5a3346b1cfcc64abca7bf768f25d1ff9e.zip
Reword "has no meaning" per suggestion
Co-authored-by: Josh Triplett <josh@joshtriplett.org>
-rw-r--r--library/std/src/env.rs4
1 files changed, 2 insertions, 2 deletions
diff --git a/library/std/src/env.rs b/library/std/src/env.rs
index d78b1d7c9cf..605925b5e96 100644
--- a/library/std/src/env.rs
+++ b/library/std/src/env.rs
@@ -573,8 +573,8 @@ impl Error for JoinPathsError {
 /// # Deprecation
 ///
 /// This function is deprecated because the behaviour on Windows is not correct.
-/// The 'HOME' environment variable has no meaning on Windows so it should not
-/// be checked. This result is that under Cygwin or Mingw it will return `/home/you`
+/// The 'HOME' environment variable is not standard on Windows, and may not produce
+/// desired results; for instance, under Cygwin or Mingw it will return `/home/you`
 /// when it should return `C:\Users\you`.
 ///
 /// # Examples