Skip to content

Commit

Permalink
Recommend the home crate in env::home_dir()'s deprecation
Browse files Browse the repository at this point in the history
  • Loading branch information
utkarshgupta137 committed Jul 19, 2023
1 parent 77e24f9 commit 6dcda77
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion library/std/src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,7 @@ impl Error for JoinPathsError {
/// 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`.
/// Consider using a crate from crates.io such as [`home`](https://crates.io/crates/home).
///
/// # Examples
///
Expand All @@ -583,7 +584,7 @@ impl Error for JoinPathsError {
#[deprecated(
since = "1.29.0",
note = "This function's behavior may be unexpected on Windows. \
Consider using a crate from crates.io instead."
Consider using a crate from crates.io such as [`home`](https://crates.io/crates/home)."
)]
#[must_use]
#[stable(feature = "env", since = "1.0.0")]
Expand Down

0 comments on commit 6dcda77

Please sign in to comment.