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.

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

doc: unify and dedupe returned values in timers.md #20310

Closed
wants to merge 1 commit into from
Closed

doc: unify and dedupe returned values in timers.md #20310

wants to merge 1 commit into from

Conversation

vsemozhetbyt
Copy link
Contributor

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@vsemozhetbyt vsemozhetbyt added the fast-track PRs that do not need to wait for 48 hours to land. label Apr 25, 2018
@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 Apr 25, 2018
@vsemozhetbyt

This comment has been minimized.

@vsemozhetbyt
Copy link
Contributor Author

Please, add 👍 here to approve fast-tracking.

@@ -28,7 +28,7 @@ functions that can be used to control this default behavior.
added: v9.7.0
-->

* Returns: {Immediate}
* Returns: {Immediate} a reference to the `immediate`
Copy link
Member

Choose a reason for hiding this comment

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

I think this should be either a reference to `immediate` or a reference to the `Immediate` and similarly below.

The first one means: A reference to the variable named "immediate".

The second one means: A reference to the instance of the Immediate object.

Copy link
Contributor Author

@vsemozhetbyt vsemozhetbyt Apr 26, 2018

Choose a reason for hiding this comment

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

I will fix with the former: we already have the type mentioned and the lowercased variant makes it clear that this is returned.

@vsemozhetbyt
Copy link
Contributor Author

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 26, 2018
@vsemozhetbyt
Copy link
Contributor Author

Landed in 65d97c9

vsemozhetbyt added a commit that referenced this pull request Apr 28, 2018
PR-URL: #20310
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
@vsemozhetbyt vsemozhetbyt deleted the doc-timers-return branch April 28, 2018 02:15
MylesBorins pushed a commit that referenced this pull request May 4, 2018
PR-URL: #20310
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
@MylesBorins MylesBorins mentioned this pull request May 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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. fast-track PRs that do not need to wait for 48 hours to land. timers Issues and PRs related to the timers subsystem / setImmediate, setInterval, setTimeout.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants