Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate Error::description for real #66919

Merged
merged 1 commit into from
Dec 26, 2019
Merged

Commits on Dec 25, 2019

  1. 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.
    dtolnay committed Dec 25, 2019
    Configuration menu
    Copy the full SHA
    4646a88 View commit details
    Browse the repository at this point in the history