(issue 16790) Added @static tag so that we can see defineProperty in API doc #16791
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Question for the reviewer - should we open another PR to make this method Public? Here's the deprecation solution that recommends its use. I confirmed when run locally that this change makes the docs show on the api website up as long as "show private/deprecated" is checked:
|
Yes. 😸 |
|
Thank you both! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With help from @jenweber, I added a
@statictag to the YUIDoc fordefineProperty, so that it may correctly appear in the Ember documentation.Please note that
definePropertyis marked as a private method, but the deprecation at https://www.emberjs.com/deprecations/v3.x#toc_ember-meta-descriptor-on-object suggests that it can be used as a public method.