doc: add quotes for event names + fix similar nits #19915
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
3 tasks
|
сс @nodejs/documentation, @Trott |
vsemozhetbyt
added
the
events
lpinca
approved these changes
Apr 10, 2018
doc/api/inspector.md
Outdated
| @@ -165,8 +165,8 @@ session.post('Profiler.enable', () => { | |||
| ``` | |||
|
|
|||
|
|
|||
| [`session.connect()`]: #inspector_session_connect | |||
| [`Debugger.paused`]: https://chromedevtools.github.io/devtools-protocol/v8/Debugger/#event-paused | |||
| [`'Debugger.paused'`]: https://chromedevtools.github.io/devtools-protocol/v8/Debugger/#event-paused | |||
There was a problem hiding this comment.
It seems working for me:
There was a problem hiding this comment.
Weird... I've refreshed with cache bypass, URLs seem identical. What can be wrong?
There was a problem hiding this comment.
What about this one (without the last slash):
https://chromedevtools.github.io/devtools-protocol/v8/Debugger#event-paused
There was a problem hiding this comment.
Changed in the fixup commit.
doc/api/util.md
Outdated
| @@ -144,7 +144,7 @@ exports.obsoleteFunction = util.deprecate(() => { | |||
| ``` | |||
|
|
|||
| When called, `util.deprecate()` will return a function that will emit a | |||
| `DeprecationWarning` using the `process.on('warning')` event. The warning will | |||
| `DeprecationWarning` using the `'warning'` event. The warning will | |||
There was a problem hiding this comment.
Nit: should we link 'warning'? Otherwise it's not clear what is the target object.
There was a problem hiding this comment.
Done in the fixup commit.
jasnell
approved these changes
Apr 10, 2018
vsemozhetbyt
added
the
author ready
trivikr
approved these changes
Apr 10, 2018
vsemozhetbyt
added
the
fast-track
|
Rebased. |
trivikr
approved these changes
Apr 12, 2018
|
Landed in 9c8857d |
trivikr
pushed a commit
that referenced
this pull request
Apr 12, 2018
PR-URL: #19915 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Apr 16, 2018
PR-URL: #19915 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
BridgeAR
pushed a commit
to BridgeAR/node
that referenced
this pull request
May 1, 2018
PR-URL: nodejs#19915 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
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) passesI've tried to process all the patterns I could think of to unify event name mentions so that they always would be wrapped in a
`'name'`way.During the overhaul, I've found some other nits and fixed them in passing:
''around other string values;''around other non-string values;`unref`dinstead of`unref`ed);'end'event for readable stream instead of'finish'event);process.on('message')event" instead of just "'message'event");These small changes can distract during reviews, but creating many PRs just for them seems to be an even bigger burden.