doc: consolidate timers docs in timers.markdown #5837
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@nodejs/documentation @Fishrock123 |
jasnell
added
doc
|
+1 and LGTM. |
|
LGTM, very reasonable. |
|
Lgtm |
|
Also: happy to close this if #5830 winds up making the same change. |
| @@ -42,7 +42,7 @@ If `callback` is not a function `setImmediate()` will throw immediately. | |||
|
|
|||
| ## setInterval(callback, delay[, arg][, ...]) | |||
|
|
|||
| To schedule the repeated execution of `callback` every `delay` milliseconds. | |||
| Schedules the repeated execution of `callback` every `delay` milliseconds. | |||
There was a problem hiding this comment.
Should the be there in this sentence?
Rather than attempting to keep two versions of docs for timers up to date, keep them in timers.markdown, and leave references to them in globals.markdown. Add setImmediate and clearImmediate to globals.markdown. Change "To schedule" to "Schedules" in timers.markdown.
bengl
force-pushed
the
consolidatetimersdocs
branch
from
312c050
to
b31bd49
Compare
|
@thefourtheye I made the changes you suggested. |
|
LGTM, I'll be merging this and closing #5830 in 24hs if no one objects. |
|
Probably we should come to an agreement about the way we represent function names as links in the docs. In few places there is As far as this patch is concerned, LGTM. |
claudiorodriguez
pushed a commit
that referenced
this pull request
Apr 2, 2016
Rather than attempting to keep two versions of docs for timers up to date, keep them in timers.markdown, and leave references to them in globals.markdown. Add setImmediate and clearImmediate to globals.markdown. Change "To schedule" to "Schedules" in timers.markdown. PR-URL: #5837 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
|
Landed in 33003a5 |
MylesBorins
pushed a commit
that referenced
this pull request
Apr 5, 2016
Rather than attempting to keep two versions of docs for timers up to date, keep them in timers.markdown, and leave references to them in globals.markdown. Add setImmediate and clearImmediate to globals.markdown. Change "To schedule" to "Schedules" in timers.markdown. PR-URL: #5837 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Apr 8, 2016
Rather than attempting to keep two versions of docs for timers up to date, keep them in timers.markdown, and leave references to them in globals.markdown. Add setImmediate and clearImmediate to globals.markdown. Change "To schedule" to "Schedules" in timers.markdown. PR-URL: #5837 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request check-list
make -j8 test(UNIX) orvcbuild test nosign(Windows) pass withthis change (including linting)?
test (or a benchmark) included?
existing APIs, or introduces new ones)?
Affected core subsystem(s)
doc
Description of change
date, keep them in timers.markdown, and leave references to them in
globals.markdown.
This implements my comment in #5830.