about summary refs log tree commit diff
path: root/library/std/src
diff options
context:
space:
mode:
Diffstat (limited to 'library/std/src')
-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