doc: general improvements to v8.md copy #6829
Conversation
jasnell
added
doc
|
/cc @nodejs/v8 |
| `GetHeapSpaceStatistics` function and may change from one V8 version to the | ||
| next. | ||
|
|
||
| The value returned is an Array of objects containing the following properties: |
There was a problem hiding this comment.
nit: we usually don't capitalize array in sentences
|
Nits addressed. PTAL |
| const v8 = require('v8'); | ||
| ``` | ||
|
|
||
| The APIs and implementation are subject to change at any time. |
There was a problem hiding this comment.
It actually means that it can have breaking changes even in minor version bumps, right?
|
@thefourtheye ... updated |
|
LGTM |
1 similar comment
|
LGTM |
| const v8 = require('v8'); | ||
| ``` | ||
|
|
||
| *Note*: The APIs and implementation are subject to change at any time. |
There was a problem hiding this comment.
This isn't, and shouldn't be true...
There was a problem hiding this comment.
The current documentation says:
This module exposes events and interfaces specific to
the version of V8 built with Node.js. These interfaces
are subject to change by upstream and are therefore
not covered under the stability index.
There was a problem hiding this comment.
Given that this edit is a restatement of the existing notice, if we want to change this and declare that the v8 module is covered by the stability index, then we can do that in a separate PR.
|
LGTM |
PR-URL: #6829 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
|
Landed in 1b7bb27 |
PR-URL: #6829 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
PR-URL: #6829 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Checklist
Affected core subsystem(s)
doc (v8)
Description of change
General improvements to v8.md copy.
/cc @nodejs/documentation @bnoordhuis