596704 - make timer module's docs call setInterval's `callback` argument a `function`

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: General, defect)

Description

[Myk Melez [:myk] [@mykmelez]]

The timer module's docs say setInterval's `callback` argument is a `callback`; it should be a `function`.

Erik Vold has provided a change that fixes the problem at http://github.com/erikvold/jetpack-sdk/commit/afa9ae9cf75ca71d3deb7d2de83c0f0e86e3d7e3.  I wanted to attach it to this bug, but GitHub doesn't seem to provide any way to download the change as a patch, and my git fu isn't yet sufficient to clone his repo and generate the patch myself.

Brian: do you know a way to get a patch out of GitHub, or must my fu improve?

Comment 1

[Erik Vold]

Attachment: Minor edit of callback argument's type in docs for timer.js module

Comment 2

[Myk Melez [:myk] [@mykmelez]]

Comment on attachment 475604 [details] [diff] [review]
Minor edit of callback argument's type in docs for timer.js module

Looks good, r=myk and a=myk for landing as low-risk fix during freeze.

Comment 3

[Brian Warner [:warner :bwarner]]

Apparently github has a fairly undocumented feature: if you append ".diff" to the commit page's URL, it'll give you a simple diff. I couldn't find an affordance (i.e. a link) for that, though.


http://github.com/erikvold/jetpack-sdk/commit/afa9ae9cf75ca71d3deb7d2de83c0f0e86e3d7e3.diff

Comment 4

[Myk Melez [:myk] [@mykmelez]]

Brian, that's awesome!

Fixed by changeset https://hg.mozilla.org/labs/jetpack-sdk/rev/7e1b40a3f664.

Erik, thanks for the fix!

Comment 5

[Erik Vold]

" if you append ".diff" to the commit page's URL, it'll give you a simple diff."

sweet!

Comment 6

[Erik Vold]

.patch works as well

Comment 7

[Myk Melez [:myk] [@mykmelez]]

The Add-on SDK is no longer a Mozilla Labs experiment and has become a big enough project to warrant its own Bugzilla product, so the "Add-on SDK" product has been created for it, and I am moving its bugs to that product.

To filter bugmail related to this change, filter on the word "looptid".