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

Editorial: refer to methods with parentheses (closes #378) #398

Merged
merged 6 commits into from
Jan 19, 2017
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -842,7 +842,7 @@ <h2>
The current <a>PaymentDetails</a> for the payment request
initially supplied to the constructor and then updated with calls
to <a data-lt=
"PaymentRequestUpdateEvent.updateWith">updateWith</a>.
"PaymentRequestUpdateEvent.updateWith">updateWith()</a>.
</td>
</tr>
<tr>
Expand All @@ -868,7 +868,7 @@ <h2>
</td>
<td>
true is there is a pending <a data-lt=
"PaymentRequestUpdateEvent.updateWith">updateWith</a> call to
"PaymentRequestUpdateEvent.updateWith">updateWith()</a> call to
update the payment request and false otherwise.
</td>
</tr>
Expand Down Expand Up @@ -997,7 +997,7 @@ <h2>
<a>PaymentRequest</a> constructor and provides information about the
requested transaction. The <a>PaymentDetails</a> dictionary is also
used to update the payment request using <a data-lt=
"PaymentRequestUpdateEvent.updateWith">updateWith</a>.
"PaymentRequestUpdateEvent.updateWith">updateWith()</a>.
</p>
<p>
The following fields are part of the <a>PaymentDetails</a> dictionary:
Expand Down Expand Up @@ -1078,7 +1078,7 @@ <h2>
</dt>
<dd>
When the payment request is updated using <a data-lt=
"PaymentRequestUpdateEvent.updateWith">updateWith</a>, the
"PaymentRequestUpdateEvent.updateWith">updateWith()</a>, the
<a>PaymentDetails</a> can contain a message in the <code>error</code>
field that will be displayed to the user. For example, this might
commonly be used to explain why goods cannot be shipped to the chosen
Expand Down Expand Up @@ -1157,7 +1157,7 @@ <h2>
</section>
<section data-dfn-for="PaymentShippingType">
<h2>
<dfn>PaymentShippingType</dfn>
<dfn>PaymentShippingType</dfn> enum
</h2>
<pre class="idl">
enum PaymentShippingType {
Expand Down Expand Up @@ -1450,7 +1450,7 @@ <h2>
The <a>PaymentShippingOption</a> dictionary has fields describing a
shipping option. A web page can provide the user with one or more
shipping options by calling the <a data-lt=
"PaymentRequestUpdateEvent.updateWith">updateWith</a> method in
"PaymentRequestUpdateEvent.updateWith">updateWith()</a> method in
response to a change event.
</p>
<p>
Expand Down Expand Up @@ -1491,7 +1491,9 @@ <h2>
</dl>
</section>
<section data-dfn-for="PaymentComplete" data-link-for="PaymentComplete">
<h2><dfn>PaymentComplete</dfn> enum</h2>
<h2>
<dfn>PaymentComplete</dfn> enum
</h2>
<pre class="idl">
enum PaymentComplete {
"fail",
Expand Down Expand Up @@ -1783,7 +1785,7 @@ <h2>
<pre class="idl">
[Constructor(DOMString type, optional PaymentRequestUpdateEventInit eventInitDict),SecureContext]
interface PaymentRequestUpdateEvent : Event {
void updateWith(Promise&lt;PaymentDetails&gt; d);
void updateWith(Promise&lt;PaymentDetails&gt; details);
};
</pre>
<p>
Expand All @@ -1792,8 +1794,8 @@ <h2>
</p>
<p>
If the web page wishes to update the payment request then it should
call <a>updateWith</a> and provide a promise that will resolve with a
<a>PaymentDetails</a> dictionary containing changed values that the
call <a>updateWith()</a> and provide a promise that will resolve with
a <a>PaymentDetails</a> dictionary containing changed values that the
<a>user agent</a> SHOULD present to the user.
</p>
<p>
Expand All @@ -1802,10 +1804,10 @@ <h2>
</p>
<section>
<h2>
<dfn>updateWith()</dfn> method
<dfn data-lt="updateWith(details)">updateWith()</dfn> method
</h2>
<p>
The <a>updateWith</a> method MUST act as follows:
The <a>updateWith(details)</a> method MUST act as follows:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Now it is inconsistent as the rest of the algorithm references <var>d</var>. This also doesn't address the <var>-in-updateWith vs. <code>-in-complete issue.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah, darn. I missed the d and code stuff. BRB!

Copy link
Member Author

Choose a reason for hiding this comment

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

(also, I prefer <var>details</var> ... more clear)

Copy link
Member Author

Choose a reason for hiding this comment

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

Argh... there is a lot of other <code> to fix...

Copy link
Member Author

Choose a reason for hiding this comment

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

I s/code/var in complete()...

</p>
<ol>
<li>Let <var>target</var> be the value of this
Expand Down