about summary refs log tree commit diff
path: root/src/libstd/sys/unix/os.rs
diff options
context:
space:
mode:
authorDavid Tolnay <dtolnay@gmail.com>2019-11-30 20:01:48 -0800
committerDavid Tolnay <dtolnay@gmail.com>2019-12-24 22:39:49 -0800
commit4646a88b7a1e68326d092b9cbbbbdd616a51077f (patch)
treee22c490b7e63a021218a48af92bc08a6483c6a9e /src/libstd/sys/unix/os.rs
parentc5a2a9a99c3973f77d7c86acb8ff7039c3d9c703 (diff)
downloadrust-4646a88b7a1e68326d092b9cbbbbdd616a51077f.tar.gz
rust-4646a88b7a1e68326d092b9cbbbbdd616a51077f.zip
Deprecate Error::description for real
`description` has been documented as soft-deprecated since 1.27.0 (17
months ago). There is no longer any reason to call it or implement it.

This commit:

- adds #[rustc_deprecated(since = "1.41.0")] to Error::description;

- moves description (and cause, which is also deprecated) below the
  source and backtrace methods in the Error trait;

- reduces documentation of description and cause to take up much less
  vertical real estate in rustdocs, while preserving the example that
  shows how to render errors without needing to call description;

- removes the description function of all *currently unstable* Error
  impls in the standard library;

- marks #[allow(deprecated)] the description function of all *stable*
  Error impls in the standard library;

- replaces miscellaneous uses of description in example code and the
  compiler.
Diffstat (limited to 'src/libstd/sys/unix/os.rs')
-rw-r--r--src/libstd/sys/unix/os.rs1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/libstd/sys/unix/os.rs b/src/libstd/sys/unix/os.rs
index 95be564b330..b0b14725344 100644
--- a/src/libstd/sys/unix/os.rs
+++ b/src/libstd/sys/unix/os.rs
@@ -213,6 +213,7 @@ impl fmt::Display for JoinPathsError {
 }
 
 impl StdError for JoinPathsError {
+    #[allow(deprecated)]
     fn description(&self) -> &str {
         "failed to join paths"
     }