Skip to content

[DOC Beta]add docs to helper files for glimmer 2#14200

Merged
rwjblue merged 1 commit intoemberjs:masterfrom
toddjordan:glimmer2-api-doc-helpers
Sep 13, 2016
Merged

[DOC Beta]add docs to helper files for glimmer 2#14200
rwjblue merged 1 commit intoemberjs:masterfrom
toddjordan:glimmer2-api-doc-helpers

Conversation

@toddjordan
Copy link
Contributor

@toddjordan toddjordan commented Sep 3, 2016

Part of #14166

Stab a converting htmlbar api documentation for glimmer 2

/**
@module ember
@submodule ember-glimmer
@public
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think @public belongs in this one

@homu
Copy link
Contributor

homu commented Sep 3, 2016

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

@toddjordan toddjordan force-pushed the glimmer2-api-doc-helpers branch 2 times, most recently from 2ab3f67 to 75b2d8a Compare September 6, 2016 02:30
@toddjordan toddjordan force-pushed the glimmer2-api-doc-helpers branch from 75b2d8a to 424343c Compare September 6, 2016 02:41
@toddjordan
Copy link
Contributor Author

Unsure where to put docs from the following files (no equivalent in the ember-glimmer package). Could use some guidance on where to put the docs for these.

  • lib/helpers/with.js
  • lib/helpers/debugger.js
  • lib/keywords/partial.js
  • lib/streams/streams.js (subscribe function is public)

@toddjordan toddjordan force-pushed the glimmer2-api-doc-helpers branch from 1acf4e9 to 054b77e Compare September 6, 2016 03:01
@@ -1,3 +1,85 @@
/**

[Glimmer](https://github.com/tildeio/glimmer) is a [Handlebars](http://handlebarsjs.com/)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the documentation to point at glimmer instead of htmlbars. Combined the ember-htmlbars and ember-templates documentation into just ember-glimmer. Need some confirmation that this is what is desired

@toddjordan toddjordan force-pushed the glimmer2-api-doc-helpers branch from 9513dbf to 2cffcf4 Compare September 6, 2016 03:33
@toddjordan toddjordan changed the title [DOC Beta]add docs to helper files [DOC Beta]add docs to helper files for glimmer 2 Sep 6, 2016
@rwjblue
Copy link
Member

rwjblue commented Sep 6, 2016

@toddjordan - I guess we can add the docs inline in ember-glimmer/index?

@toddjordan
Copy link
Contributor Author

toddjordan commented Sep 6, 2016

ok, did that

@toddjordan toddjordan force-pushed the glimmer2-api-doc-helpers branch from 2cffcf4 to 5b29c54 Compare September 6, 2016 20:39
*/

/**
A method of subscribing to a stream which is safe for use with a non-stream
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure that Ember.stream.subscribe even exists, but it was public. Any thoughts?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it was only public behind a feature flag (was never exposed without flag enabled, and the flag was never enabled). ✂️ all references to "streams"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✂️ 'd

@toddjordan toddjordan force-pushed the glimmer2-api-doc-helpers branch from 5b29c54 to 6f6e014 Compare September 7, 2016 14:25
@toddjordan
Copy link
Contributor Author

toddjordan commented Sep 8, 2016

@rwjblue I believe a 2.8 docs release is happening soon (today?) Do you think this is ready? And should this be merged into something other than master?

EDIT: nevermind... Got my 2.8 and 2.9 mixed up :-P false alarm

@homu
Copy link
Contributor

homu commented Sep 8, 2016

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

@rwjblue
Copy link
Member

rwjblue commented Sep 9, 2016

Sorry about this needing a rebase, I missed the last round of fixes before I merged #14231.

@toddjordan
Copy link
Contributor Author

that's ok. I'll do that now

@toddjordan toddjordan force-pushed the glimmer2-api-doc-helpers branch from 6f6e014 to 3d95fbf Compare September 9, 2016 02:58
@toddjordan toddjordan closed this Sep 9, 2016
@toddjordan toddjordan force-pushed the glimmer2-api-doc-helpers branch from 3d95fbf to 31a8d68 Compare September 9, 2016 03:03
@toddjordan toddjordan reopened this Sep 9, 2016
@toddjordan toddjordan force-pushed the glimmer2-api-doc-helpers branch 4 times, most recently from 4400b6a to 2873c8e Compare September 9, 2016 04:07
@homu
Copy link
Contributor

homu commented Sep 12, 2016

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

@toddjordan toddjordan force-pushed the glimmer2-api-doc-helpers branch from 2873c8e to a35b84d Compare September 13, 2016 04:47
Additional updates

minor tweaks

combined htmlbars and ember-templates doc

fix some code samples

Added some missing public docs to index.js

remove stream doc

fix merge/rebase blunder

update import missed on merge
@toddjordan toddjordan force-pushed the glimmer2-api-doc-helpers branch from 158cf6c to 31c015b Compare September 13, 2016 04:52
@rwjblue
Copy link
Member

rwjblue commented Sep 13, 2016

Thank you!

@rwjblue rwjblue merged commit f66b62e into emberjs:master Sep 13, 2016
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