doc: fix/improve inspector profiler example #19379
Merged
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
nodejs-github-bot
added
doc
cjihrig
approved these changes
Mar 16, 2018
richardlau
approved these changes
Mar 16, 2018
doc/api/inspector.md
Outdated
| // write profile to disk, upload, etc. | ||
| fs.writeFileSync('./profile.cpuprofile', JSON.stringify(profile)); |
There was a problem hiding this comment.
Do we have a policy on whether to include the require calls for common modules such as fs in sample code?
There was a problem hiding this comment.
Added a require of 'fs'.
fhinkel
approved these changes
Mar 16, 2018
jasnell
approved these changes
Mar 16, 2018
ratracegrad
approved these changes
Mar 17, 2018
lpinca
reviewed
Mar 18, 2018
doc/api/inspector.md
Outdated
| // write profile to disk, upload, etc. | ||
| fs.writeFileSync('./profile.cpuprofile', JSON.stringify(profile)); |
There was a problem hiding this comment.
Should the example use profile only if err is falsy?
ofrobots
force-pushed
the
inspector-example
branch
from
c22568b to
fbaa4c9
Compare
lpinca
approved these changes
Mar 20, 2018
The first parameter to the callback is `err`. Fix that. Expand example to demonstrate an actual write to disk. PR-URL: nodejs#19379 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
ofrobots
force-pushed
the
inspector-example
branch
from
fbaa4c9 to
2725acf
Compare
|
Landed in 2725acf. |
MylesBorins
pushed a commit
that referenced
this pull request
Mar 22, 2018
The first parameter to the callback is `err`. Fix that. Expand example to demonstrate an actual write to disk. PR-URL: #19379 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[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.
The first parameter to the callback is
err. Fix that. Expand exampleto demonstrate an actual write to disk.
Checklist
CI-lite:
https://ci.nodejs.org/job/node-test-commit-lite/410/https://ci.nodejs.org/job/node-test-commit-lite/433/