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 beta] Enforce public/private declaration for API docs. #11362

Merged
merged 1 commit into from Jun 7, 2015

Conversation

Projects
None yet
2 participants
@rwjblue
Member

rwjblue commented Jun 7, 2015

This PR ensures that all YUIDoc comment blocks (those starting with /**) are properly marked as either @private or @public.

A number of times throughout the Ember 1.x cycle we have internally struggled with what things are or are not public. This PR "solves" that by making it extremely clear.

In addition to documenting each comment block, a new JSCS rule has been added to ensure all documentation blocks are labeled properly in the future.


Please note: This PR makes an initial attempt based on my best understanding. These @public and @private declarations can absolutely be reviewed and changed as needed.

rwjblue added a commit that referenced this pull request Jun 7, 2015

Merge pull request #11362 from rwjblue/enforce-documentation-access-s…
…pecifics

[DOC beta] Enforce public/private declaration for API docs.

@rwjblue rwjblue merged commit f1d1da9 into emberjs:master Jun 7, 2015

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@rwjblue rwjblue deleted the rwjblue:enforce-documentation-access-specifics branch Jun 7, 2015

@DingoEatingFuzz

This comment has been minimized.

Show comment
Hide comment
@DingoEatingFuzz

DingoEatingFuzz Jul 17, 2015

Hello @rwjblue, I come to haunt your @private/@public decisions. Namely sortBy being marked private. I came across this in the API and was taken by surprise. We use this a lot in our app and in our tests.

Is there an issue or anything I can be pointed to to read more about the method access decisions?

Hello @rwjblue, I come to haunt your @private/@public decisions. Namely sortBy being marked private. I came across this in the API and was taken by surprise. We use this a lot in our app and in our tests.

Is there an issue or anything I can be pointed to to read more about the method access decisions?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment