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

jsdoc: add Helpers methods namespace #3172

Merged
merged 4 commits into from Nov 2, 2017
Merged

jsdoc: add Helpers methods namespace #3172

merged 4 commits into from Nov 2, 2017

Conversation

machikoyasuda
Copy link
Contributor

@machikoyasuda machikoyasuda commented Oct 25, 2017 •
edited

What this PR does:

  • Adds Helpers namespace for both client and server-side methods

Questions for discussion:

  • Should Helpers be broken out into Client-side helpers and Server-side helpers?
  • Example: There are 3 methods named getSlug(), from lib/api/helpers.js, client/modules/core/helpers/utils.js, server/api/core/utils.js. Should these be in separate Helper buckets, like Client-side Helpers, Server-side Helpers and API Helpers?

screen shot 2017-10-25 at 12 38 47 pm

How that renders:

screen shot 2017-10-25 at 12 36 58 pm

spencern
spencern approved these changes Oct 31, 2017
View reviewed changes
Copy link
Contributor

@spencern spencern left a comment

Choose a reason for hiding this comment

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

Looks good to me

@zenweasel zenweasel changed the base branch from master to release-1.5.6 November 2, 2017 21:54
@zenweasel zenweasel merged commit 139ebf3 into release-1.5.6 Nov 2, 2017
@zenweasel zenweasel deleted the jsdoc-group-helpers branch November 2, 2017 21:58
@zenweasel zenweasel mentioned this pull request Nov 2, 2017
Merged
Akarshit pushed a commit that referenced this pull request Jan 7, 2018
@zenweasel
Merge pull request #3172 from reactioncommerce/jsdoc-group-helpers
84c8075 
jsdoc: add Helpers methods namespace
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@spencern spencern spencern approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@machikoyasuda @spencern @zenweasel