rephrase API docs in tracing.md #35556
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
PoojaDurgad
force-pushed
the
api-version
branch
from
ed2b9dd
to
8319d41
Compare
HarshithaKP
approved these changes
Oct 8, 2020
richardlau
reviewed
Oct 8, 2020
doc/api/tracing.md
Outdated
| @@ -80,7 +80,7 @@ string that supports `${rotation}` and `${pid}`: | |||
| node --trace-event-categories v8 --trace-event-file-pattern '${pid}-${rotation}.log' server.js | |||
| ``` | |||
|
|
|||
| Starting with Node.js 10.0.0, the tracing system uses the same time source | |||
| Starting with Node.js v10.0.0, the tracing system uses the same time source | |||
There was a problem hiding this comment.
We avoid the v prefix in prose, see https://github.com/nodejs/node/blob/master/doc/guides/doc-style-guide.md.
- When referring to a version of Node.js in prose, use Node.js and the version
number. Do not prefix the version number with v in prose. This is to avoid
confusion about whether v8 refers to Node.js 8.x or the V8 JavaScript
engine.
- OK: Node.js 14.x, Node.js 14.3.1
- NOT OK: Node.js v14
Trott
reviewed
Oct 8, 2020
doc/api/tracing.md
Outdated
Comment on lines
83
to
86
| Starting with Node.js v10.0.0, the tracing system uses the same time source | ||
| as the one used by `process.hrtime()` | ||
| however the trace-event timestamps are expressed in microseconds, | ||
| unlike `process.hrtime()` which returns nanoseconds. |
There was a problem hiding this comment.
The addition of v here violates our style guide as noted by @richardlau above. However, the text here could stand some other improvements:
- Might be a good idea to remove "Starting with Node.js 10.0.0". These docs are for a specific version of Node.js.
- The sentence is a run-on sentence. It would be better split into two sentences.
Suggested change
| Starting with Node.js v10.0.0, the tracing system uses the same time source | |
| as the one used by `process.hrtime()` | |
| however the trace-event timestamps are expressed in microseconds, | |
| unlike `process.hrtime()` which returns nanoseconds. | |
| The tracing system uses the same time source | |
| as the one used by `process.hrtime()`. | |
| However the trace-event timestamps are expressed in microseconds, | |
| unlike `process.hrtime()` which returns nanoseconds. |
There was a problem hiding this comment.
@Trott - thanks for the review, I understand. I have followed your suggestions. Please have a look.
PoojaDurgad
changed the title
Trott
approved these changes
Oct 9, 2020
PR-URL: nodejs#35556 Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
|
Landed in ff4928f |
MylesBorins
pushed a commit
that referenced
this pull request
Oct 14, 2020
PR-URL: #35556 Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Nov 3, 2020
PR-URL: #35556 Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Nov 16, 2020
PR-URL: #35556 Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
joesepi
pushed a commit
to joesepi/node
that referenced
this pull request
Jan 8, 2021
PR-URL: nodejs#35556 Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
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