Skip to content
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

doc: mark optional parameters in timers.md #35764

Closed
wants to merge 1 commit into from
Closed

doc: mark optional parameters in timers.md #35764

wants to merge 1 commit into from

Conversation

vsemozhetbyt
Copy link
Contributor

Checklist

  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. timers Issues and PRs related to the timers subsystem / setImmediate, setInterval, setTimeout. labels Oct 22, 2020
@vsemozhetbyt
Copy link
Contributor Author

vsemozhetbyt commented Oct 22, 2020 •
edited
Loading

Slashes in headings seem redundant: https://nodejs.org/docs/latest-v15.x/api/timers.html#timers_timerspromises_settimeout_delay_value_options

aduh95
aduh95 approved these changes Oct 22, 2020
View reviewed changes
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

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

LGTM

For reference, the timer default value is defined here:

node/lib/internal/timers.js

Line 172 in 3f4ec9c

after = 1; // Schedule on next tick, follows browser behavior

@gireeshpunathil gireeshpunathil added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels Oct 25, 2020
gireeshpunathil pushed a commit that referenced this pull request Oct 25, 2020
@vsemozhetbyt @gireeshpunathil
doc: mark optional parameters in timers.md
9437e2f 
PR-URL: #35764
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@gireeshpunathil
Copy link
Member

landed in 9437e2f

@vsemozhetbyt vsemozhetbyt deleted the doc-timers branch October 25, 2020 13:23
targos pushed a commit that referenced this pull request Nov 3, 2020
@vsemozhetbyt @targos
doc: mark optional parameters in timers.md
368ae95 
PR-URL: #35764
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@targos targos mentioned this pull request Nov 3, 2020
Merged
BethGriggs pushed a commit that referenced this pull request Dec 8, 2020
@vsemozhetbyt @BethGriggs
doc: mark optional parameters in timers.md
fd2a834 
PR-URL: #35764
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
BethGriggs pushed a commit that referenced this pull request Dec 10, 2020
@vsemozhetbyt @BethGriggs
doc: mark optional parameters in timers.md
1e16b38 
PR-URL: #35764
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@BethGriggs BethGriggs mentioned this pull request Dec 10, 2020
Merged
BethGriggs pushed a commit that referenced this pull request Dec 15, 2020
@vsemozhetbyt @BethGriggs
doc: mark optional parameters in timers.md
62bf1a6 
PR-URL: #35764
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@richardlau richardlau removed the request-ci Add this label to start a Jenkins CI on a PR. label Jan 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aduh95 aduh95 aduh95 approved these changes

@gireeshpunathil gireeshpunathil gireeshpunathil approved these changes

@lpinca lpinca lpinca approved these changes

@Trott Trott Trott approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. timers Issues and PRs related to the timers subsystem / setImmediate, setInterval, setTimeout.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@vsemozhetbyt @gireeshpunathil @Trott @lpinca @aduh95 @richardlau @nodejs-github-bot