doc,test: update v8 method doc and comment

Update documentation and test comment for v8.cachedDataVersionTag(). PR-URL: #35795 Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
nodejs · Nov 3, 2020 · 092c6c4 · 092c6c4
1 parent b07f4a3
commit 092c6c4
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/doc/api/v8.md b/doc/api/v8.md
@@ -18,11 +18,20 @@ added: v8.0.0
 
 * Returns: {integer}
 
-Returns an integer representing a "version tag" derived from the V8 version,
-command-line flags and detected CPU features. This is useful for determining
+Returns an integer representing a version tag derived from the V8 version,
+command-line flags, and detected CPU features. This is useful for determining
 whether a [`vm.Script`][] `cachedData` buffer is compatible with this instance
 of V8.
 
+```js
+console.log(v8.cachedDataVersionTag()); // 3947234607
+// The value returned by v8.cachedDataVersionTag() is derived from the V8
+// version, command-line flags, and detected CPU features. Test that the value
+// does indeed update when flags are toggled.
+v8.setFlagsFromString('--allow_natives_syntax');
+console.log(v8.cachedDataVersionTag()); // 183726201
+```
+
 ## `v8.getHeapSpaceStatistics()`
 <!-- YAML
 added: v6.0.0

diff --git a/test/parallel/test-v8-version-tag.js b/test/parallel/test-v8-version-tag.js
@@ -7,9 +7,9 @@ const versionTag1 = v8.cachedDataVersionTag();
 assert.strictEqual(typeof versionTag1, 'number');
 assert.strictEqual(v8.cachedDataVersionTag(), versionTag1);
 
-// The value of cachedDataVersionTag is derived from the command line flags and
-// detected CPU features. Test that the value does indeed update when flags
-// are toggled.
+// The value returned by v8.cachedDataVersionTag() is derived from the V8
+// version, command-line flags, and detected CPU features. Test that the value
+// does indeed update when flags are toggled.
 v8.setFlagsFromString('--allow_natives_syntax');
 
 const versionTag2 = v8.cachedDataVersionTag();