Fix typo and incorrect JSDoc references in Invoice and PaymentRefund#411
Open
Alexander M. Marin (madmarin) wants to merge 1 commit intomercadopago:masterfrom
Conversation
- Rename parameter ivoicesSearchOptions to invoicesSearchOptions in Invoice.search() to correct a copy-paste typo - Fix JSDoc on PaymentRefund.total() which incorrectly described the method as "Create Refund" and linked to the create example; now correctly says "Total Refund" and links to total.ts example - Fix describe label in refundTotal.spec.ts which said "create" instead of "total" due to copy-paste from create.spec.ts
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 does this PR fix?
Three copy-paste bugs found in
InvoiceandPaymentRefundclients:1. Typo in
Invoice.search()parameter nameivoicesSearchOptions→invoicesSearchOptionsFile:
src/clients/invoice/index.ts2. Wrong JSDoc on
PaymentRefund.total()The
total()method had the JSDoc copied fromcreate():create.tsinstead oftotal.ts(which already exists)File:
src/clients/paymentRefund/index.ts3. Wrong
describelabel inrefundTotal.spec.tsTest suite said
"Testing payments refunds, create"but tests thetotalfunction.File:
src/clients/paymentRefund/total/refundTotal.spec.tsTesting
All existing tests pass with no modifications required.