Skip to content

[DOC release] Initial pass at filtering out api docs behind FFs#13105

Merged
rwjblue merged 1 commit intoemberjs:masterfrom
toddjordan:hide-feature-flagged-apis
Apr 4, 2016
Merged

[DOC release] Initial pass at filtering out api docs behind FFs#13105
rwjblue merged 1 commit intoemberjs:masterfrom
toddjordan:hide-feature-flagged-apis

Conversation

@toddjordan
Copy link
Contributor

This PR is to address issue #13101

It uses a yuidoc preprocessor to parse features.json and determine features that are not yet turned on by default. If not turned on, any class with an @category tag matching that feature will be filtered out of the api docs class list.

@toddjordan
Copy link
Contributor Author

cc @rwjblue
This PR is currently filtering out the 2 engines classes according to features.json. We will need to figure out other classes associated with features and label their @category accordingly.

@homu
Copy link
Contributor

homu commented Mar 16, 2016

☔ The latest upstream changes (presumably #12211) made this pull request unmergeable. Please resolve the merge conflicts.

@toddjordan toddjordan force-pushed the hide-feature-flagged-apis branch from 1f2e7e7 to 5dfcc47 Compare March 17, 2016 02:20
@toddjordan toddjordan force-pushed the hide-feature-flagged-apis branch from 5dfcc47 to 7627553 Compare March 24, 2016 19:35
@rwjblue
Copy link
Member

rwjblue commented Apr 4, 2016

This looks great! I think we also need to be able to filter @method and @property declarations too (seems like this is working on @class only right?).

@toddjordan toddjordan force-pushed the hide-feature-flagged-apis branch from 7627553 to 7723a94 Compare April 4, 2016 01:30
@toddjordan
Copy link
Contributor Author

right. I'll work on a separate PR for that

@rwjblue
Copy link
Member

rwjblue commented Apr 4, 2016

Sounds good, we'll land this once Travis is happy (prior failure was unrelated and caused by Sauce Labs issue).

@toddjordan
Copy link
Contributor Author

@rwjblue Travis happy now 😀

@rwjblue rwjblue merged commit b57d70f into emberjs:master Apr 4, 2016
@rwjblue
Copy link
Member

rwjblue commented Apr 4, 2016

Thanks @toddjordan!

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.

3 participants