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.

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

docs(jsdoc): #3840 document all Meteor Template helpers in 1 @namespace #3841

Merged

Conversation

machikoyasuda
Copy link
Contributor

Resolves #3840
Impact: minor
Type: docs

Issue

  • Meteor Template helpers were not documented, or not displaying on api.docs.reactioncommerce.com

Solution

  • added @memberof Templates to methods
  • added @namespace Templates
  • added @file information with Blaze helper method docs links

Breaking changes

none

Testing

  1. Pull this PR
  2. Run npm run docs
  3. Open file:///tmp/reaction-docs/Templates.html

Screenshots

screen shot 2018-02-26 at 4 39 47 pm

@machikoyasuda machikoyasuda changed the title docs(jsdoc): document all Meteor Template helpers in 1 @namespace docs(jsdoc): #3840 document all Meteor Template helpers in 1 @namespace Feb 27, 2018
Copy link
Collaborator

@brent-hoover brent-hoover left a comment

Choose a reason for hiding this comment

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

Some of these helpers aren't necessarily template-specific I think?

* etc: "additional properties as defined in Packages.registry"
* ...
* }]
* @method Apps
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't know that this is actually a template helper? We use it in templates but I think we use it elsewhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Would reactionApps be a better fit in Helpers?

@aldeed
Copy link
Contributor

aldeed commented Apr 26, 2018

Note that I made some changes in #4213 that might impact this PR a little. I think it would still be fine to update and merge this PR if time permits, but it's also not critical IMO because we're working toward removing Blaze.

@aldeed aldeed changed the base branch from master to release-1.13.0 June 1, 2018 21:10
@aldeed aldeed merged commit d497978 into release-1.13.0 Jun 1, 2018
@aldeed aldeed deleted the docs-3840-machikoyasuda-jsdoc-template-helpers branch June 1, 2018 21:55
@aldeed
Copy link
Contributor

aldeed commented Jun 1, 2018

I fixed up and merged this

@spencern spencern mentioned this pull request Jun 4, 2018
@machikoyasuda
Copy link
Contributor Author

Thank you @aldeed!

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