Document the limitations on chrome.alarms timing.

Document the limitations on chrome.alarms timing.

Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=175277

[Jeffrey Yasskin, 2013-01-04 02:06:00]

This could probably use some wordsmithing, but it's a start. It's in response to
https://groups.google.com/a/chromium.org/d/topic/chromium-extensions/0XgFNSy3...

[not at google - send to devlin, 2013-01-04 22:36:57]

lgtm, various optional suggestions.

https://codereview.chromium.org/11761031/diff/1/chrome/common/extensions/docs...
File chrome/common/extensions/docs/templates/intros/alarms.html (right):

https://codereview.chromium.org/11761031/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/intros/alarms.html:27: periodically.  In
order to reduce the load on the user's machine,
New paragraph from "In order..."

https://codereview.chromium.org/11761031/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/intros/alarms.html:28: Chrome limits
alarms to at most once every 5 minutes and may delay
s/and/but/

https://codereview.chromium.org/11761031/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/intros/alarms.html:29: them an arbitrary
amount more than that.  That is, setting
s/than that//

https://codereview.chromium.org/11761031/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/intros/alarms.html:36: that soon.</p>
s/closer/sooner/

s/that soon/until later/

https://codereview.chromium.org/11761031/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/intros/alarms.html:39: unpacked, there's
no limit to how often the alarm can fire.</p>
s/however, //
s/unpacked, /unpacked/

[Jeffrey Yasskin, 2013-01-04 22:51:16]

https://codereview.chromium.org/11761031/diff/1/chrome/common/extensions/docs...
File chrome/common/extensions/docs/templates/intros/alarms.html (right):

https://codereview.chromium.org/11761031/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/intros/alarms.html:27: periodically.  In
order to reduce the load on the user's machine,
On 2013/01/04 22:36:57, kalman wrote:
> New paragraph from "In order..."

Done.

https://codereview.chromium.org/11761031/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/intros/alarms.html:28: Chrome limits
alarms to at most once every 5 minutes and may delay
On 2013/01/04 22:36:57, kalman wrote:
> s/and/but/

Done.

https://codereview.chromium.org/11761031/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/intros/alarms.html:29: them an arbitrary
amount more than that.  That is, setting
On 2013/01/04 22:36:57, kalman wrote:
> s/than that//

Done.

https://codereview.chromium.org/11761031/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/intros/alarms.html:36: that soon.</p>
On 2013/01/04 22:36:57, kalman wrote:
> s/closer/sooner/
> 
> s/that soon/until later/

Mostly done, with a few tweaks of my own.

https://codereview.chromium.org/11761031/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/intros/alarms.html:39: unpacked, there's
no limit to how often the alarm can fire.</p>
On 2013/01/04 22:36:57, kalman wrote:
> s/however, //
> s/unpacked, /unpacked/

Done.

[mkearney1, 2013-01-04 22:59:52]

https://codereview.chromium.org/11761031/diff/5001/chrome/common/extensions/d...
File chrome/common/extensions/docs/templates/intros/alarms.html (right):

https://codereview.chromium.org/11761031/diff/5001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/intros/alarms.html:24: </table>
What does this look like right under the table? Should it maybe be under a
heading? Maybe call it 'alarm frequency' or 'time limits', something like that.

https://codereview.chromium.org/11761031/diff/5001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/intros/alarms.html:27: periodically.</p>
Alarms can be used in apps too, so best to say 'app or extension'.

https://codereview.chromium.org/11761031/diff/5001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/intros/alarms.html:37: set sooner than 5
minutes after "now" but won't actually cause the
Slight smoothing of wording here: 

" ... can be set to less than 5, translating to less than 5 minutes after "now",
but won't actually cause the alarm to run for at least 5 minutes."

https://codereview.chromium.org/11761031/diff/5001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/intros/alarms.html:40: <p>To help you
debug your extension, when you've loaded it unpacked
Again, you should say 'app or extension'. Also, add a comma after 'when you've
loaded it unpacked,'.

[Jeffrey Yasskin, 2013-01-04 23:19:52]

https://codereview.chromium.org/11761031/diff/5001/chrome/common/extensions/d...
File chrome/common/extensions/docs/templates/intros/alarms.html (right):

https://codereview.chromium.org/11761031/diff/5001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/intros/alarms.html:24: </table>
On 2013/01/04 22:59:52, mkearney1 wrote:
> What does this look like right under the table? Should it maybe be under a
> heading? Maybe call it 'alarm frequency' or 'time limits', something like
that.

Done.

https://codereview.chromium.org/11761031/diff/5001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/intros/alarms.html:27: periodically.</p>
On 2013/01/04 22:59:52, mkearney1 wrote:
> Alarms can be used in apps too, so best to say 'app or extension'.

Done.

https://codereview.chromium.org/11761031/diff/5001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/intros/alarms.html:37: set sooner than 5
minutes after "now" but won't actually cause the
On 2013/01/04 22:59:52, mkearney1 wrote:
> Slight smoothing of wording here: 
> 
> " ... can be set to less than 5, translating to less than 5 minutes after
"now",
> but won't actually cause the alarm to run for at least 5 minutes."

|when| is actually ms-past-the-epoch, so I used "can be set to less than 5
minutes after "now" but won't actually cause the alarm to run for at least 5
minutes."

https://codereview.chromium.org/11761031/diff/5001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/intros/alarms.html:40: <p>To help you
debug your extension, when you've loaded it unpacked
On 2013/01/04 22:59:52, mkearney1 wrote:
> Again, you should say 'app or extension'. Also, add a comma after 'when you've
> loaded it unpacked,'.

Done.

[mkearney1, 2013-01-04 23:27:10]

lgtm

[commit-bot: I haz the power, 2013-01-04 23:35:09]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/jyasskin@chromium.org/11761031/5003

[commit-bot: I haz the power, 2013-01-05 03:33:31]

Change committed as 175277