doc: unify and dedupe returned values in timers.md #20310
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
vsemozhetbyt
added
the
fast-track
nodejs-github-bot
added
doc
This comment has been minimized.
This comment has been minimized.
|
Please, add 👍 here to approve fast-tracking. |
Trott
reviewed
Apr 26, 2018
doc/api/timers.md
Outdated
| @@ -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` | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
I will fix with the former: we already have the type mentioned and the lowercased variant makes it clear that this is returned.
BridgeAR
approved these changes
Apr 26, 2018
BridgeAR
added
the
author ready
trivikr
approved these changes
Apr 26, 2018
jasnell
approved these changes
Apr 27, 2018
TimothyGu
approved these changes
Apr 27, 2018
|
Landed in 65d97c9 |
vsemozhetbyt
added a commit
that referenced
this pull request
Apr 28, 2018
PR-URL: #20310 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
May 4, 2018
PR-URL: #20310 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
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.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes