1116413 - Example in comment for PromiseUtils.resolveOrTimeout has TypeError.

Status: RESOLVED FIXED

(Toolkit :: Async Tooling, defect)

Description

[Tooru Fujisawa [:arai]]

http://dxr.mozilla.org/mozilla-central/source/toolkit/modules/PromiseUtils.jsm#15
>   * Example:
>   * resolveOrTimeout(myModule.shutdown(), 1000, new Error("The module took too long to shutdown"));

Third argument should be a function, like:
  resolveOrTimeout(myModule.shutdown(), 1000, () => new Error("The module took too long to shutdown"));

Comment 1

[Tooru Fujisawa [:arai]]

Attachment: Fix example comment for PromiseUtils.resolveOrTimeout.

Comment 2

[David Teller [:Yoric] - still alive but not very active]

Comment on attachment 8543017 [details] [diff] [review]
Fix example comment for PromiseUtils.resolveOrTimeout.

Review of attachment 8543017 [details] [diff] [review]:
-----------------------------------------------------------------

Good catch, thank you very much for the patch.
Two things before we can land it:
- can you add `,r=yoric` at the end of your commit message? we do this to track reviewers for patches;
- while you are at it, can you cut the comment line you just fixed in two, i.e. put `() => ...` on a second line?

Comment 3

[Tooru Fujisawa [:arai]]

Thank you for reviewing :D

https://hg.mozilla.org/integration/mozilla-inbound/rev/fbb35d6d4151

Comment 4

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/fbb35d6d4151