-
Notifications
You must be signed in to change notification settings - Fork 66
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
Conversation
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: |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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= |
There was a problem hiding this comment.
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"
There was a problem hiding this comment.
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> |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
PTAL. |
Added a fix for #36 as well. PTAL. |
There was a problem hiding this 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 :)
Closes #36, #37, #40 and #43.
Preview | Diff