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

Remove PaymentCurrencyAmount dictionary from MDN #9736

Merged
merged 1 commit into from
Oct 11, 2021
Merged

Remove PaymentCurrencyAmount dictionary from MDN #9736

merged 1 commit into from
Oct 11, 2021

Conversation

queengooborg
Copy link
Collaborator

This PR removes the documentation for the PaymentCurrencyAmount dictionary and folds its contents into the documentation for the PaymentItem dictionary. Correlates with its removal in BCD, see mdn/browser-compat-data#12794.

@queengooborg queengooborg requested review from a team as code owners October 11, 2021 19:33
@queengooborg queengooborg requested review from wbamberg and removed request for a team October 11, 2021 19:33
@github-actions github-actions bot added the Content:WebAPI Web API docs label Oct 11, 2021
@github-actions
Copy link
Contributor

Preview URLs

Flaws

URL: /en-US/docs/Web/API/PaymentItem
Title: PaymentItem
on GitHub
Flaw count: 6

  • macros:
    • /en-US/docs/Web/API/PaymentItem/amount does not exist
    • /en-US/docs/Web/API/PaymentItem/label does not exist
    • /en-US/docs/Web/API/PaymentItem/pending does not exist
  • bad_bcd_links:
    • no explanation!
    • no explanation!
    • no explanation!

External URLs

URL: /en-US/docs/Web/API/PaymentItem
Title: PaymentItem
on GitHub

@hamishwillee
Copy link
Collaborator

Same question for this one. Great job on the dictionary inclusion, but can/should we retain any example code from the deleted docs?

@queengooborg
Copy link
Collaborator Author

I don't think it's particularly valuable (slight pun intended) to include either of the examples on the deleted docs. The description for the properties of the PaymentItem.amount object are pretty self-explanatory, I believe!

@hamishwillee
Copy link
Collaborator

Fair enough. This was just a prompt to ensure that you'd considered the examples, not that I thought they had to be copied :-)

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

Thanks very much. Merging

@hamishwillee hamishwillee merged commit fddece9 into mdn:main Oct 11, 2021
@queengooborg queengooborg deleted the PaymentCurrencyAmount branch October 11, 2021 23:10
@@ -19,7 +19,9 @@ The {{domxref("PaymentItem")}} dictionary is used by the [Payment Request API](/
## Properties

- {{domxref("PaymentItem.amount", "amount")}} {{securecontext_inline}}
- : A {{domxref("PaymentCurrencyAmount")}} object describing the monetary value of the item.
- : An object describing the monetary value of the item. This object includes the following fields:
Copy link
Contributor

Choose a reason for hiding this comment

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

I see a mix of terminology across PRs. I think "fields" here should be "properties".

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah that's my bad -- would you be willing to send a PR to update the wording for consistency? I'll happily review and merge them right away!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:WebAPI Web API docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants