Skip to content

Commit 2cefb58

Browse files
marcoscaceresmarcoscaceres
committed
Editorial: markup and consistency fixes
1 parent 911b675 commit 2cefb58

File tree

1 file changed

+77
-83
lines changed

1 file changed

+77
-83
lines changed

‎index.html

Lines changed: 77 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1294,25 +1294,21 @@ <h2>
12941294
supported <a>payment methods</a> and any associated <a>payment
12951295
method</a> specific data for those methods.
12961296
</p>
1297-
<p>
1298-
The following members are part of the <a>PaymentMethodData</a>
1299-
dictionary:
1300-
</p>
13011297
<dl>
13021298
<dt>
13031299
<dfn>supportedMethods</dfn> member
13041300
</dt>
13051301
<dd>
1306-
<a>supportedMethods</a> is a <a>payment method identifier</a> for a
1307-
<a>payment method</a> that the merchant web site accepts.
1302+
A <a>payment method identifier</a> for a <a>payment method</a> that
1303+
the merchant web site accepts.
13081304
</dd>
13091305
<dt>
13101306
<dfn>data</dfn> member
13111307
</dt>
13121308
<dd>
1313-
<a>data</a> is an object that provides optional information that
1314-
might be needed by the supported payment methods. If supplied, it
1315-
will be <a>JSON-serialized</a>.
1309+
An object that provides optional information that might be needed by
1310+
the supported payment methods. If supplied, it will be
1311+
<a>JSON-serialized</a>.
13161312
</dd>
13171313
</dl>
13181314
<p class="note">
@@ -1484,33 +1480,30 @@ <h2>
14841480
sequence&lt;PaymentShippingOption&gt; shippingOptions;
14851481
sequence&lt;PaymentDetailsModifier&gt; modifiers;
14861482
};
1487-
</pre>
1488-
<p>
1489-
The following members are part of the <a>PaymentDetailsBase</a>
1490-
dictionary:
1491-
</p>
1483+
</pre>
14921484
<dl>
14931485
<dt>
14941486
<dfn>displayItems</dfn> member
14951487
</dt>
14961488
<dd>
1497-
This sequence of <a>PaymentItem</a> dictionaries contains line
1498-
items for the payment request that the <a>user agent</a> MAY
1499-
display. For example, it might include details of products or
1500-
breakdown of tax and shipping. It is optional to provide this
1501-
information.
1502-
<p class="note">
1489+
A sequence of <a>PaymentItem</a> dictionaries contains line items
1490+
for the payment request that the <a>user agent</a> MAY display. For
1491+
example, it might include details of products or breakdown of tax
1492+
and shipping. It is optional to provide this information.
1493+
<aside class="note">
15031494
It is the developer's responsibility to verify that the
15041495
<a data-lt="PaymentDetailsInit.total">total</a> amount is the sum
15051496
of these items.
1506-
</p>
1497+
</aside>
15071498
</dd>
15081499
<dt>
15091500
<dfn>shippingOptions</dfn> member
15101501
</dt>
15111502
<dd>
1512-
A sequence containing the different shipping options for the user
1513-
to choose from.
1503+
<p>
1504+
A sequence containing the different shipping options for the user
1505+
to choose from.
1506+
</p>
15141507
<p>
15151508
If an item in the sequence has the <a data-lt=
15161509
"PaymentShippingOption.selected">selected</a> member set to true,
@@ -1531,21 +1524,21 @@ <h2>
15311524
<a data-lt="PaymentOptions.requestShipping">requestShipping</a>
15321525
set to true.
15331526
</p>
1534-
<p class="note">
1527+
<aside class="note">
15351528
If the sequence has an item with the <a data-lt=
15361529
"PaymentShippingOption.selected">selected</a> member set to true,
15371530
then authors are responsible for ensuring that the <a data-lt=
15381531
"PaymentDetailsInit.total">total</a> member includes the cost of
15391532
the shipping option. This is because no
15401533
<a>shippingoptionchange</a> event will be fired for this option
15411534
unless the user selects an alternative option first.
1542-
</p>
1535+
</aside>
15431536
</dd>
15441537
<dt>
15451538
<dfn>modifiers</dfn> member
15461539
</dt>
15471540
<dd>
1548-
This sequence of <a>PaymentDetailsModifier</a> dictionaries
1541+
A sequence of <a>PaymentDetailsModifier</a> dictionaries that
15491542
contains modifiers for particular payment method identifiers. For
15501543
example, it allows you to adjust the total amount based on payment
15511544
method.
@@ -1558,15 +1551,15 @@ <h2>
15581551
<dfn>PaymentDetailsInit</dfn> dictionary
15591552
</h2>
15601553
<pre class="idl">
1561-
dictionary PaymentDetailsInit : PaymentDetailsBase {
1562-
DOMString id;
1563-
required PaymentItem total;
1564-
};
1565-
</pre>
1566-
<p class="note">
1554+
dictionary PaymentDetailsInit : PaymentDetailsBase {
1555+
DOMString id;
1556+
required PaymentItem total;
1557+
};
1558+
</pre>
1559+
<aside class="note">
15671560
The <a>PaymentDetailsInit</a> dictionary is used in the construction
15681561
of the payment request.
1569-
</p>
1562+
</aside>
15701563
<p>
15711564
In addition to the members inherited from the
15721565
<a>PaymentDetailsBase</a> dictionary, the following members are part
@@ -1577,26 +1570,26 @@ <h2>
15771570
<dfn>id</dfn> member
15781571
</dt>
15791572
<dd>
1580-
<a>id</a> is a free-form identifier for this payment request.
1581-
<p class="note">
1573+
A free-form identifier for this payment request.
1574+
<aside class="note">
15821575
If an <a>id</a> member is not present, then the <a>user agent</a>
15831576
will generate a unique identifier for the payment request during
15841577
<a data-lt="PaymentRequest.PaymentRequest()">construction</a>.
1585-
</p>
1578+
</aside>
15861579
</dd>
15871580
<dt>
15881581
<dfn>total</dfn> member
15891582
</dt>
15901583
<dd>
1591-
This <a>PaymentItem</a> contains the non-negative total amount of
1592-
the payment request.
1593-
<p class="note">
1584+
A <a>PaymentItem</a> containing a non-negative total amount for the
1585+
payment request.
1586+
<aside class="note">
15941587
Algorithms in this specification that accept a
15951588
<a>PaymentDetailsInit</a> dictionary will throw if the
15961589
<a>total</a>.<a data-lt=
15971590
"PaymentItem.amount">amount</a>.<a data-lt=
15981591
"PaymentCurrencyAmount.value">value</a> is a negative number.
1599-
</p>
1592+
</aside>
16001593
</dd>
16011594
</dl>
16021595
</section>
@@ -1606,11 +1599,11 @@ <h2>
16061599
<dfn>PaymentDetailsUpdate</dfn> dictionary
16071600
</h2>
16081601
<pre class="idl">
1609-
dictionary PaymentDetailsUpdate : PaymentDetailsBase {
1610-
DOMString error;
1611-
PaymentItem total;
1612-
};
1613-
</pre>
1602+
dictionary PaymentDetailsUpdate : PaymentDetailsBase {
1603+
DOMString error;
1604+
PaymentItem total;
1605+
};
1606+
</pre>
16141607
<p>
16151608
The <a>PaymentDetailsUpdate</a> dictionary is used to update the
16161609
payment request using <a data-lt=
@@ -1626,9 +1619,9 @@ <h2>
16261619
<dfn>error</dfn> member
16271620
</dt>
16281621
<dd>
1629-
When the payment request is updated using <a data-lt=
1630-
"PaymentRequestUpdateEvent.updateWith">updateWith()</a>, the
1631-
<a>PaymentDetailsUpdate</a> can contain a message in the
1622+
A human-readable string. When the payment request is updated using
1623+
<a data-lt="PaymentRequestUpdateEvent.updateWith">updateWith()</a>,
1624+
the <a>PaymentDetailsUpdate</a> can contain a message in the
16321625
<a>error</a> member that will be displayed to the user, if the
16331626
<a>PaymentDetailsUpdate</a> indicates that there are no valid
16341627
<a data-lt="PaymentDetailsBase.shippingOptions">shippingOptions</a>
@@ -1642,7 +1635,8 @@ <h2>
16421635
<dfn>total</dfn> member
16431636
</dt>
16441637
<dd>
1645-
This <a>PaymentItem</a> contains the non-negative total amount.
1638+
A <a>PaymentItem</a> contains the non-negative <a data-lt=
1639+
"PaymentItem.amount">amount</a>.
16461640
<p class="note">
16471641
Algorithms in this specification that accept a
16481642
<a>PaymentDetailsUpdate</a> dictionary will throw if the
@@ -1677,15 +1671,15 @@ <h2>
16771671
<dfn>supportedMethods</dfn> member
16781672
</dt>
16791673
<dd>
1680-
The <a>supportedMethods</a> member is a <a>payment method
1681-
identifier</a>. The members of the <a>PaymentDetailsModifier</a> only
1682-
apply if the user select this <a>payment method</a>.
1674+
A <a>payment method identifier</a>. The members of the
1675+
<a>PaymentDetailsModifier</a> only apply if the user select this
1676+
<a>payment method</a>.
16831677
</dd>
16841678
<dt>
16851679
<dfn>total</dfn> member
16861680
</dt>
16871681
<dd>
1688-
This <a>PaymentItem</a> value overrides the <a data-lt=
1682+
A <a>PaymentItem</a> value that overrides the <a data-lt=
16891683
"PaymentDetailsInit.total">total</a> member in the
16901684
<a>PaymentDetailsInit</a> dictionary for the <a>payment method
16911685
identifiers</a> of the <a>supportedMethods</a> member.
@@ -1694,7 +1688,7 @@ <h2>
16941688
<dfn>additionalDisplayItems</dfn> member
16951689
</dt>
16961690
<dd>
1697-
This sequence of <a>PaymentItem</a> dictionaries provides additional
1691+
A sequence of <a>PaymentItem</a> dictionaries provides additional
16981692
display items that are appended to the <a data-lt=
16991693
"PaymentDetailsBase.displayItems">displayItems</a> member in the
17001694
<a>PaymentDetailsBase</a> dictionary for the <a>payment method
@@ -1713,9 +1707,8 @@ <h2>
17131707
<dfn>data</dfn> member
17141708
</dt>
17151709
<dd>
1716-
<a>data</a> is an object that provides optional information that
1717-
might be needed by the supported payment methods. If supplied, it
1718-
will be <a>JSON-serialized</a>.
1710+
An object that provides optional information that might be needed by
1711+
the supported payment methods.
17191712
</dd>
17201713
</dl>
17211714
</section>
@@ -1778,49 +1771,50 @@ <h2>
17781771
<dfn>requestPayerName</dfn> member
17791772
</dt>
17801773
<dd>
1781-
This boolean value indicates whether the <a>user agent</a> SHOULD
1782-
collect and return the payer's name as part of the payment request.
1783-
For example, this would be set to true to allow a merchant to make a
1774+
A boolean that indicates whether the <a>user agent</a> SHOULD collect
1775+
and return the payer's name as part of the payment request. For
1776+
example, this would be set to true to allow a merchant to make a
17841777
booking in the payer's name.
17851778
</dd>
17861779
<dt>
17871780
<dfn>requestPayerEmail</dfn> member
17881781
</dt>
17891782
<dd>
1790-
This boolean value indicates whether the <a>user agent</a> SHOULD
1791-
collect and return the payer's email address as part of the payment
1792-
request. For example, this would be set to true to allow a merchant
1793-
to email a receipt.
1783+
A boolean that indicates whether the <a>user agent</a> SHOULD collect
1784+
and return the payer's email address as part of the payment request.
1785+
For example, this would be set to true to allow a merchant to email a
1786+
receipt.
17941787
</dd>
17951788
<dt>
17961789
<dfn>requestPayerPhone</dfn> member
17971790
</dt>
17981791
<dd>
1799-
This boolean value indicates whether the <a>user agent</a> SHOULD
1800-
collect and return the payer's phone number as part of the payment
1801-
request. For example, this would be set to true to allow a merchant
1802-
to phone a customer with a billing enquiry.
1792+
A boolean that indicates whether the <a>user agent</a> SHOULD collect
1793+
and return the payer's phone number as part of the payment request.
1794+
For example, this would be set to true to allow a merchant to phone a
1795+
customer with a billing enquiry.
18031796
</dd>
18041797
<dt>
18051798
<dfn>requestShipping</dfn> member
18061799
</dt>
18071800
<dd>
1808-
This boolean value indicates whether the <a>user agent</a> SHOULD
1809-
collect and return a shipping address as part of the payment request.
1810-
For example, this would be set to true when physical goods need to be
1801+
A boolean that indicates whether the <a>user agent</a> SHOULD collect
1802+
and return a shipping address as part of the payment request. For
1803+
example, this would be set to true when physical goods need to be
18111804
shipped by the merchant to the user. This would be set to false for
18121805
an online-only electronic purchase transaction.
18131806
</dd>
18141807
<dt>
18151808
<dfn>shippingType</dfn> member
18161809
</dt>
18171810
<dd>
1818-
Some transactions require an address for delivery but the term
1819-
"shipping" isn't appropriate. For example, "pizza delivery" not
1820-
"pizza shipping" and "laundry pickup" not "laundry shipping". If
1821-
<a>requestShipping</a> is set to true, then the <a>shippingType</a>
1822-
member may be used to influence the way the <a>user agent</a>
1823-
presents the user interface for gathering the shipping address.
1811+
A <a>ShippingType</a> enum value. Some transactions require an
1812+
address for delivery but the term "shipping" isn't appropriate. For
1813+
example, "pizza delivery" not "pizza shipping" and "laundry pickup"
1814+
not "laundry shipping". If <a>requestShipping</a> is set to true,
1815+
then the <a>shippingType</a> member can influence the way the <a>user
1816+
agent</a> presents the user interface for gathering the shipping
1817+
address.
18241818
<p>
18251819
The <a>shippingType</a> member only affects the user interface for
18261820
the payment request.
@@ -1849,8 +1843,8 @@ <h2>
18491843
<dfn>label</dfn> member
18501844
</dt>
18511845
<dd>
1852-
This is a human-readable description of the item. The <a>user
1853-
agent</a> may display this to the user.
1846+
A human-readable description of the item. The <a>user agent</a> may
1847+
display this to the user.
18541848
</dd>
18551849
<dt>
18561850
<dfn>amount</dfn> member
@@ -1863,7 +1857,7 @@ <h2>
18631857
<dfn>pending</dfn> member
18641858
</dt>
18651859
<dd>
1866-
When set to true this member means that the <a>amount</a> member is
1860+
A boolean. When set to true it means that the <a>amount</a> member is
18671861
not final. This is commonly used to show items such as shipping or
18681862
tax amounts that depend upon selection of shipping address or
18691863
shipping option. <a>User agents</a> MAY indicate pending fields in
@@ -2026,15 +2020,15 @@ <h2>
20262020
<dfn>id</dfn> member
20272021
</dt>
20282022
<dd>
2029-
This is a string identifier used to reference this
2023+
A string identifier used to reference this
20302024
<a>PaymentShippingOption</a>. It MUST be unique for a given
20312025
<a>PaymentRequest</a>.
20322026
</dd>
20332027
<dt>
20342028
<dfn>label</dfn> member
20352029
</dt>
20362030
<dd>
2037-
This is a human-readable description of the item. The <a>user
2031+
A human-readable string description of the item. The <a>user
20382032
agent</a> SHOULD use this string to display the shipping option to
20392033
the user.
20402034
</dd>
@@ -2049,7 +2043,7 @@ <h2>
20492043
<dfn>selected</dfn> member
20502044
</dt>
20512045
<dd>
2052-
This is set to true to indicate that this is the default selected
2046+
A boolean. When true, it indicates that this is the default selected
20532047
<a>PaymentShippingOption</a> in a sequence. <a>User agents</a> SHOULD
20542048
display this option by default in the user interface.
20552049
</dd>

0 commit comments

Comments
 (0)