Skip to content
This repository has been archived by the owner on Mar 22, 2019. It is now read-only.

Add deprecation guide for ember-views.lifecycle-hook-arguments #2761

Closed
locks opened this issue Dec 15, 2016 · 0 comments
Closed

Add deprecation guide for ember-views.lifecycle-hook-arguments #2761

locks opened this issue Dec 15, 2016 · 0 comments

Comments

@locks
Copy link
Contributor

locks commented Dec 15, 2016

As per the deprecation RFC process, it is necessary to write a corresponding deprecation guide. While the RFC is not merged yet, meaning the deprecation is not in the codebase, much less part of a release, we can preemptively write the guide so everything is ready to go.

The steps should be roughly the following:

  1. Read the RFC (link above), specifically "Transition Path" and "How We Teach This"
  2. Add a Deprecations Added in Pending Features header to the Ember 2.x file
  3. Add a deprecation guide for ember-views.lifecycle-hook-arguments

We need step 2 since it'll be the first of its kind in the Ember 2.x file, and because the RFC still doesn't have a release as mentioned above.
For step 3 it needs to be the following structure:

#### <Title of the deprecation>

##### until: <Ember version where this might be removed>
##### id: <id of the deprecation>

<explanation of how to update the code in order to resolve the deprecation>

You can grab the id from the Ember PR linked at the top of the post.
The until version is usually 3.0.0, but since this is a deprecation of a private API it should be the version after the next LTS. You can also find this information in the Ember PR!
The explanation should be a combination of "Transition Path" and "How We Teach This".

cc @jenweber

@locks locks changed the title Add deprecation guide for ember-views.lifecycle-hook-arguments [META] ember-views.lifecycle-hook-arguments deprecation Dec 15, 2016
@locks locks changed the title [META] ember-views.lifecycle-hook-arguments deprecation Add deprecation guide for ember-views.lifecycle-hook-arguments Dec 15, 2016
@locks locks closed this as completed Jan 9, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant