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

fix: Allow people to opt-in to deprecations #3830

Merged
merged 1 commit into from Jun 14, 2022
Merged

Commits on Jun 14, 2022

  1. fix: Allow people to opt-in to deprecations

    This adds a new `Cargo.toml` feature named `deprecated` that opts
    controls whether deprecation warnings show up.  This is starting off as
    non-default though that may change (see below).
    
    Benefits
    - Allows a staged rollout so a smaller subset of users see new
      deprecations and can report their experience with them before everyone
      sees them.  For example, this reduces the number of people who have to
      deal with clap-rs#3822.
    - This allows people to defer responding to each new batch of
      deprecations and instead do it at once.  This means we should
      reconsider clap-rs#3616.
    
    The one risk is people who don't follow blog posts and guides having a
    harder time upgrading to the next breaking release without the warnings
    on by default.  For these users, we reserve the right to make the
    `deprecated` feature `default`.  This is most likely to happen in a
    minor release that is released in conjunction with the next major
    release (e.g. when releasing 4.0.0, we release a 3.3.0 that enables
    deprecations by default).  By using a feature, users can still disable
    this if they want.
    
    Thanks @joshtriplett for the idea
    epage committed Jun 14, 2022
    Copy the full SHA
    7515bfe View commit details
    Browse the repository at this point in the history