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

jsdoc: add Orders, Shipping, Payment methods from core #3167

Merged
merged 6 commits into from
Nov 9, 2017

Conversation

machikoyasuda
Copy link
Contributor

@machikoyasuda machikoyasuda commented Oct 25, 2017

What this PR does

  1. Adds Methods/Orders
  2. Adds Methods/Shipping
  3. Adds Methods/Payment

What that renders

screen shot 2017-10-24 at 6 30 19 pm

@machikoyasuda machikoyasuda changed the title jsdoc: add more method namespaces jsdoc: add more method Oct 25, 2017
@machikoyasuda machikoyasuda changed the title jsdoc: add more method jsdoc: add more methods from core Oct 25, 2017
@machikoyasuda machikoyasuda changed the title jsdoc: add more methods from core jsdoc: add Orders, Shipping, Payment methods from core Oct 25, 2017
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.

A few questions

// returns entire payment method
/**
* @name orderCreditMethod
* @summary Helper to return the order credit object.
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this one need a memberof Methods/Orders tag?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

✔️


/**
* @name createShipmentQuotes
* @private
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need a summary for this private method?

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 required but good to have.

/**
* @summary if we have items in the cart, ensure that we only have shipping records for shops currently represented in the cart
* @name pruneShippingRecordsByShop
Copy link
Contributor

Choose a reason for hiding this comment

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

Guessing we're not using the @membeof here because it's private?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Correct. @private methods don't need @memberof. But they should still have @summary for people to read in the code itself.

@machikoyasuda
Copy link
Contributor Author

Updated for comments + updated master branch

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.

👍

@spencern spencern changed the base branch from master to release-1.5.7 November 9, 2017 00:41
@spencern
Copy link
Contributor

spencern commented Nov 9, 2017

eslint passes locally.

@spencern spencern merged commit b22e322 into release-1.5.7 Nov 9, 2017
@spencern spencern deleted the jsdoc-leftover-meteor-methods branch November 9, 2017 00:44
@spencern spencern mentioned this pull request Nov 9, 2017
Akarshit pushed a commit that referenced this pull request Jan 7, 2018
…methods

jsdoc: add Orders, Shipping, Payment methods from core
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.

2 participants