doc: reference {set,clear}Immediate in Globals #5830
Conversation
setImmediate/clearImmediate are globals, but not mentioned in the Globals documentation section.
trevnorris
force-pushed
the
fix-globals-doc
branch
from
2c6b4ca
to
8a14d93
Compare
|
LGTM nit: curious if we should include a link to some more in depth documentation on the event loop |
| @@ -162,6 +166,21 @@ left untouched. | |||
| Use the internal `require()` machinery to look up the location of a module, | |||
| but rather than loading the module, just return the resolved filename. | |||
|
|
|||
| ## setImmediate(callback[, arg][, ...]) | |||
|
|
|||
| To schedule the "immediate" execution of `callback` after I/O events' | |||
There was a problem hiding this comment.
Can you change "To schedule" to "Schedules".
There was a problem hiding this comment.
This is copied verbatum from the timers documentation. If changed in one place should change in another. That alright?
|
LGTM with one comment. |
|
|
|
Preferably what @bengl said imo. |
|
+1 to @bengl's comment |
|
@bengl So basically be: ## setTimeout(cb, ms)
See [link to timers markdown] |
|
@trevnorris Yep. |
|
Merged #5837, which also solves this. |
setImmediate/clearImmediateare globals, but not mentioned in theGlobals documentation section.
R=@nodejs/documentation