Fix broken links in Payment API

[skyclouds2001]

Description

updateWith() method is defined on PaymentRequestUpdateEvent and PaymentMethodChangeEvent simply inherit this method from PaymentRequestUpdateEvent

PaymentInstrument is a non-standard dictionary and hasn't its own documentation, so remove its mention

payerdetailchange event is fired on PaymentResponse rather then PaymentRequest

PaymentShippingOption is a non-standard dictionary and hasn't its own documentation

PaymentDetailsModifier is a dictionary and hasn't its own documentation, so add for its detail

AddressErrors is a non-standard dictionary and hasn't its own documentation

retry() and complete() methods are on PaymentResponse just removes these links

Motivation

Additional details

Related issues and pull requests

[github-actions]

Preview URLs (8 pages)

• /en-US/docs/Web/API/PaymentRequest/merchantvalidation_event
• /en-US/docs/Web/API/PaymentRequest/paymentmethodchange_event
• /en-US/docs/Web/API/PaymentRequest/show
• /en-US/docs/Web/API/PaymentRequestEvent/changePaymentMethod
• /en-US/docs/Web/API/PaymentRequestEvent/modifiers
• /en-US/docs/Web/API/PaymentRequestEvent
• /en-US/docs/Web/API/PaymentRequestUpdateEvent/PaymentRequestUpdateEvent
• /en-US/docs/Web/API/PaymentRequestUpdateEvent/updateWith

(comment last updated: 2024-01-22 18:40:05)

[wbamberg]

Thank you @skyclouds2001 !

It's important that we explain the syntax of dictionary objects, even if we don't have a separate page for them.

Also it looks like:

• the shipping options were removed (in Drop PaymentAddress, shipping + billing address support w3c/payment-request#955 I think)
• we are referring to PaymenrDetailsModifier in a few places and therefore should probably have a dictionary page for it.

[teoli2003]

Yes, this page is a complex one.

The general rule about dictionaries is that:

• we don't mention the dictionary name because it is not visible to the user.
• on each page where a dictionary is used, a list of its fields must be listed.

We do sometimes make exceptions:

• for very long dictionaries used on several pages, we can have a specific entry (not the cases here)
• when we have long dictionaries used in one constructor and one getter, we sometimes describe them in the constructor and only link to the object description of it in the getter. There must be a link to it.
• we don't need to describe everything for each object occurrence on the page, but only once per page, usually in the Value or Return value sections or in the Parameters one.

The difficulty on this API is that some of these dictionaries are being phased out (non-standard or deprecated) but have not been removed from the implementation. This is a reason why this has not been cleaned before.

[teoli2003]

Two sentences were not clear to me (it wasn't an extensive review).

[wbamberg]

👍 thank you!