Skip to content

doc: reference {set,clear}Immediate in Globals #5830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
trevnorris wants to merge 1 commit into from
Closed

doc: reference {set,clear}Immediate in Globals #5830

trevnorris wants to merge 1 commit into from

Conversation

@trevnorris
Copy link
Contributor

@trevnorris trevnorris commented Mar 21, 2016

setImmediate/clearImmediate are globals, but not mentioned in the
Globals documentation section.

R=@nodejs/documentation

@trevnorris trevnorris added the doc Issues and PRs related to the documentations. label Mar 21, 2016
@trevnorris
doc: reference {set,clear}Immediate in Globals
8a14d93 
setImmediate/clearImmediate are globals, but not mentioned in the
Globals documentation section.
@MylesBorins
Copy link
Contributor

MylesBorins commented Mar 21, 2016

LGTM

nit: curious if we should include a link to some more in depth documentation on the event loop

cjihrig
cjihrig reviewed Mar 21, 2016
View reviewed changes
doc/api/globals.markdown

## setImmediate(callback[, arg][, ...])

To schedule the "immediate" execution of `callback` after I/O events'
Copy link
Contributor

@cjihrig cjihrig Mar 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you change "To schedule" to "Schedules".

Copy link
Contributor Author

@trevnorris trevnorris Mar 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is copied verbatum from the timers documentation. If changed in one place should change in another. That alright?

Copy link
Contributor

@cjihrig cjihrig Mar 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh. Yea.

@cjihrig
Copy link
Contributor

cjihrig commented Mar 21, 2016

LGTM with one comment.

@bengl
Copy link
Member

bengl commented Mar 21, 2016

setImmediate/clearImmediate are documented in timers.markdown. In addition, the existing documentation for things that are in both timers.markdown and globals.markdown are somewhat different. Maybe they could be consolidated in timers.markdown leaving only references to them in globals.markdown?

@Fishrock123
Copy link
Contributor

Fishrock123 commented Mar 21, 2016

Preferably what @bengl said imo.

@thefourtheye
Copy link
Contributor

thefourtheye commented Mar 21, 2016

+1 to @bengl's comment

@bengl bengl mentioned this pull request Mar 21, 2016
Closed
4 tasks
@trevnorris
Copy link
Contributor Author

trevnorris commented Mar 21, 2016

@bengl So basically be:

## setTimeout(cb, ms)

See [link to timers markdown]

@bengl
Copy link
Member

bengl commented Mar 21, 2016

@trevnorris Yep.

@claudiorodriguez
Copy link
Contributor

claudiorodriguez commented Apr 2, 2016

Merged #5837, which also solves this.

@a0viedo a0viedo mentioned this pull request Apr 15, 2016
Closed
@trevnorris trevnorris deleted the fix-globals-doc branch August 9, 2016 22:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@trevnorris @MylesBorins @cjihrig @bengl @Fishrock123 @thefourtheye @claudiorodriguez @jasnell