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

[DOC] Update docs to show deprecate function within @ember/debug package #17926

Merged
merged 1 commit into from
Jun 17, 2019
Merged

[DOC] Update docs to show deprecate function within @ember/debug package #17926

merged 1 commit into from
Jun 17, 2019

Conversation

elwayman02
Copy link
Contributor

@elwayman02 elwayman02 commented Apr 15, 2019

The current docs show it within the @ember/application/deprecations package, when it physically lives within @ember/debug.

Fixes #17185

cc: @rwjblue

@locks
Copy link
Contributor

locks commented Apr 16, 2019

According to https://github.com/ember-cli/ember-rfc176-data, the current documentation is the correct one, so I'm closing this PR.
When we move to proper packages we should take care to handle these sort of edge cases!

@locks locks closed this Apr 16, 2019
@rwjblue rwjblue reopened this Apr 16, 2019
@rwjblue
Copy link
Member

rwjblue commented Apr 16, 2019

@locks - The documentation is wrong for deprecate, as is ember-rfc176-data.

@rwjblue
Copy link
Member

rwjblue commented Apr 16, 2019

Specifically, importing deprecate from @ember/application/deprecations will result in the build tooling not properly stripping those deprecations.

While researching I found a number of (pretty prominent) addons using import { deprecate } from '@ember/debug (see here), but there are also quite a few more that import { deprecate } from '@ember/application/deprecations' (see here).

🤔

@locks
Copy link
Contributor

locks commented Apr 16, 2019

Hm, should we come up with an action plan next framework meeting?

@rwjblue
Copy link
Member

rwjblue commented Apr 16, 2019

Hm, should we come up with an action plan next framework meeting?

Ya, sounds good. I think either way we need to make both imports work (and have the stripping behaviors), but seems like a great thing to discuss more broadly.

@rwjblue
Copy link
Member

rwjblue commented Apr 19, 2019

We discussed this during today's Ember core team meeting:

  1. We will update the build system to ensure importing deprecate from either @ember/debug or @ember/application/deprecations have the same production stripping behaviors.
  2. Update ember-rfc176-data's mapping.json to allow both locations, and mark the @ember/application/deprecations path as deprecated: true (this will aid the eslint rule's --fix to allow quick and easy conversion).
  3. Update the docs (this PR) to point folks to using @ember/debug

@locks locks self-assigned this May 16, 2019
bekzod added a commit to bekzod/ember-rfc176-data that referenced this pull request May 18, 2019
bekzod added a commit to bekzod/ember-rfc176-data that referenced this pull request May 18, 2019
@bekzod
Copy link
Contributor

bekzod commented May 18, 2019

@rwjblue
Copy link
Member

rwjblue commented May 24, 2019

@bekzod - We also need to make ember-cli-babel have the same stripping in prod behaviors for @ember/application/deprecations stuff

@bekzod
Copy link
Contributor

bekzod commented May 24, 2019

Ok will add then

@rwjblue
Copy link
Member

rwjblue commented Jun 17, 2019

@rwjblue
Copy link
Member

rwjblue commented Jun 17, 2019

All the pieces are in place now, this should be good to go now.

@rwjblue rwjblue merged commit d2199e7 into emberjs:master Jun 17, 2019
@rwjblue
Copy link
Member

rwjblue commented Jun 17, 2019

Thanks @elwayman02 / @xg-wang / @bekzod for pushing this forward!

chriskrycho added a commit to chriskrycho/DefinitelyTyped that referenced this pull request Nov 29, 2022
These were incorrectly documented as being part of this package for a
long time, and so the types included them; but this was fixed as of
Ember 3.12 (in [this PR][1]), three and a half years ago, and our types
never got the message! 😬

[1]: emberjs/ember.js#17926
chriskrycho added a commit to chriskrycho/DefinitelyTyped that referenced this pull request Nov 29, 2022
These were incorrectly documented as being part of this package for a
long time, and so the types included them; but this was fixed as of
Ember 3.12 (in [this PR][1]), three and a half years ago, and our types
never got the message! 😬

[1]: emberjs/ember.js#17926
chriskrycho added a commit to chriskrycho/DefinitelyTyped that referenced this pull request Nov 29, 2022
These were incorrectly documented as being part of this package for a
long time, and so the types included them; but this was fixed as of
Ember 3.12 (in [this PR][1]), three and a half years ago, and our types
never got the message! 😬

[1]: emberjs/ember.js#17926
chriskrycho added a commit that referenced this pull request Nov 29, 2022
These were incorrectly documented as being part of this package for a
long time, and so the types included them; but this was fixed as of
Ember 3.12 (in [this PR][1]), three and a half years ago, and our types
never got the message! 😬

[1]: #17926
chriskrycho added a commit that referenced this pull request Nov 30, 2022
These were incorrectly documented as being part of this package for a
long time, and so the types included them; but this was fixed as of
Ember 3.12 (in [this PR][1]), three and a half years ago, and our types
never got the message! 😬

[1]: #17926

(cherry picked from commit 02a334f)
chriskrycho added a commit that referenced this pull request Nov 30, 2022
These were incorrectly documented as being part of this package for a
long time, and so the types included them; but this was fixed as of
Ember 3.12 (in [this PR][1]), three and a half years ago, and our types
never got the message! 😬

[1]: #17926

(cherry picked from commit 02a334f)
typescript-bot pushed a commit to DefinitelyTyped/DefinitelyTyped that referenced this pull request Dec 5, 2022
…ctions by @chriskrycho

These were incorrectly documented as being part of this package for a
long time, and so the types included them; but this was fixed as of
Ember 3.12 (in [this PR][1]), three and a half years ago, and our types
never got the message! 😬

[1]: emberjs/ember.js#17926
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] API docs should suggest deprecate be imported from @ember/debug
4 participants