Skip to content

Miscellaneous spec cleanup (no normative changes) #44

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

Merged
merged 10 commits into from
Jun 23, 2017

Conversation

mgiuca
Copy link
Collaborator

@mgiuca mgiuca commented Jun 21, 2017

Closes #36, #37, #40 and #43.


Preview | Diff

@mgiuca
Copy link
Collaborator Author

mgiuca commented Jun 21, 2017

@domenic Fixes #37 and #40 that you filed, looks good?

index.html Outdated
@@ -112,10 +112,11 @@
</h4>
<p>
When the <dfn>share</dfn> method is called with argument
<var>data</var>, run the following steps:
<var>data</var>, the user agent MUST run the following steps:
Copy link

Choose a reason for hiding this comment

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

FYI at least in specs that depend on Infra, this is implied: https://infra.spec.whatwg.org/#algorithms

index.html Outdated
are installed, or which app was chosen from
<a><code>navigator.share</code></a>, because this information could be
used for fingerprinting, as well as leaking details about the user's
device.
</li>
<li>Implementors should carefully consider what information is revealed
Copy link

Choose a reason for hiding this comment

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

"should" is still normative; maybe move this to the step that rejects the promise?

presents the user with a dialog asking them to select a target
application (even if there is only one possible target). This surface
serves as a security confirmation, ensuring that websites cannot
silently send data to native applications.
</li>
<li>Due to the capabilities of the API surface,
<a><code>navigator.share</code></a> is <a data-cite=
Copy link

Choose a reason for hiding this comment

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

There's an errant "may leak private data" below that ideally would be "might". The same bullet also contains a "should" which I am not sure what to do with.

Similarly, "may be used" should be "can be used", and "should be aware" should be, e.g., "will want to be aware"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.

"will want to be aware" sounds very watery, but I can't think of anything better that doesn't involve these words.

@@ -330,22 +335,23 @@
(depending on the underlying platform).
</p>
<ul>
Copy link

Choose a reason for hiding this comment

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

The introduction still contains "should", and seems out of place since this is supposed to be now re-stating requirements expressed elsewhere.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done. I've grepped the whole document for all reserved words in RFC 2119 and rewritten the sentences around them (or, in one case, upgraded "may" to "MAY").

@@ -171,21 +172,25 @@
these steps.
Copy link

Choose a reason for hiding this comment

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

Above this, "reject" should also link to the promises-guide

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.

@mgiuca
Copy link
Collaborator Author

mgiuca commented Jun 22, 2017

PTAL.

@mgiuca
Copy link
Collaborator Author

mgiuca commented Jun 22, 2017

Added a fix for #36 as well. PTAL.

Copy link

@domenic domenic left a comment

Choose a reason for hiding this comment

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

Looks great, thanks! Especially with the base URL change though, this might not count as "editorial" anymore, just for the sake of the commit message :)

@mgiuca mgiuca merged commit 770eb7c into w3c:master Jun 23, 2017
@mgiuca mgiuca deleted the spec-cleanup branch July 3, 2017 07:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants