jsdoc: add Orders, Shipping, Payment methods from core #3167
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
October 24, 2017 18:28
machikoyasuda
changed the title
machikoyasuda
changed the title
machikoyasuda
changed the title
spencern
reviewed
Oct 31, 2017
server/methods/core/orders.js
Outdated
| // returns entire payment method | ||
| /** | ||
| * @name orderCreditMethod | ||
| * @summary Helper to return the order credit object. |
There was a problem hiding this comment.
Does this one need a memberof Methods/Orders tag?
|
|
||
| /** | ||
| * @name createShipmentQuotes | ||
| * @private |
There was a problem hiding this comment.
Do we need a summary for this private method?
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
Guessing we're not using the @membeof here because it's private?
There was a problem hiding this comment.
Correct. @private methods don't need @memberof. But they should still have @summary for people to read in the code itself.
|
Updated for comments + updated master branch |
|
eslint passes locally. |
Merged
Akarshit
pushed a commit
that referenced
this pull request
Jan 7, 2018
…methods jsdoc: add Orders, Shipping, Payment methods from core
This was referenced Jun 20, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does
Methods/OrdersMethods/ShippingMethods/PaymentWhat that renders