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.

Sign up for GitHub

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

Jump to bottom

getOwner missing from API Docs? #13734

Closed
justinaray opened this issue Jun 21, 2016 · 4 comments
Closed

getOwner missing from API Docs? #13734

justinaray opened this issue Jun 21, 2016 · 4 comments
Labels
Documentation Good for New Contributors tooling

Comments

@justinaray
Copy link

Please forgive the issue if I'm missing it or it's documented elsewhere, but I don't see the getOwner or setOwner methods in the Ember module API docs.

I obviously know about them from the blog posts and guides, but was surprised when I checked the API.
@rwjblue
Copy link
Member

rwjblue commented Jun 21, 2016

Hmm. Documentation was written for it (here), I am not sure why it isn't showing up though.

@justinaray
Copy link
Author

justinaray commented Jun 21, 2016 •
edited
Loading

Maybe the api generation needs a @since tag? Or the tag order is important. Only differences I can see with other methods that add to the Ember module.

https://github.com/emberjs/ember.js/blob/v2.6.0/packages/ember-metal/lib/utils.js#L415-L428

@rwjblue
Copy link
Member

rwjblue commented Jun 21, 2016

Since would be good to add, but it shouldn't be required. My guess is that it is either order dependent or that we aren't included docs from the container package.

@justinaray
Copy link
Author

Yeah, just noticed that @since isn't on many of the other methods (e.g. $). Agree about the other two likely causes.

sukima added a commit to sukima/ember.js that referenced this issue Jul 14, 2016
@sukima
Add since param to getOwner docs
fc162b9 
Per the discussion on emberjs#13734 I added the since parameter and reordered
to match other files. I searched the history to find the version number
when this was introduced:

    git log --stat -- packages/container/lib/owner.js
    git tag --contains 7d7450c

Fixes emberjs#13734
@sukima sukima mentioned this issue Jul 14, 2016
Merged
sukima added a commit to sukima/ember.js that referenced this issue Jul 14, 2016
@sukima
Add container to yuidoc.json
c47b176 
Fixes emberjs#13734
toddjordan pushed a commit to toddjordan/ember.js that referenced this issue Sep 9, 2016
@sukima @toddjordan
Add since param to getOwner docs
34b009b 
Per the discussion on emberjs#13734 I added the since parameter and reordered
to match other files. I searched the history to find the version number
when this was introduced:

    git log --stat -- packages/container/lib/owner.js
    git tag --contains 7d7450c

Fixes emberjs#13734
toddjordan pushed a commit to toddjordan/ember.js that referenced this issue Sep 9, 2016
@sukima @toddjordan
Add container to yuidoc.json
78fbcd0 
Fixes emberjs#13734
webark pushed a commit to webark/ember.js that referenced this issue Oct 6, 2016
@sukima @webark
Add since param to getOwner docs
4679995 
Per the discussion on emberjs#13734 I added the since parameter and reordered
to match other files. I searched the history to find the version number
when this was introduced:

    git log --stat -- packages/container/lib/owner.js
    git tag --contains 7d7450c

Fixes emberjs#13734
webark pushed a commit to webark/ember.js that referenced this issue Oct 6, 2016
@sukima @webark
Add container to yuidoc.json
ca92aa1 
Fixes emberjs#13734
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Good for New Contributors tooling
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mixonic @rwjblue @justinaray