Skip to content

Commit b88d113

Browse files
committed
update v8ForceOptimization docs
1 parent 409e2fc commit b88d113

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

benchmark/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -235,12 +235,12 @@ it returns to accomplish what they need. This function reports timing
235235
data to the parent process (usually created by running `compare.js`, `run.js` or
236236
`scatter.js`).
237237

238-
### v8ForceOptimization(method)
238+
### v8ForceOptimization(method[, ...args])
239239

240-
Force V8 to optimize the function with the native function
240+
Force V8 to mark the `method` for optimization with the native function
241241
`%OptimizeFunctionOnNextCall()` and return the optimization status
242242
after that.
243243

244-
It is used to prevent the benchmark from getting disrupted
245-
by the optimizer kicking in halfway through. However, this could result in a
246-
less effective optimization, so it should be used with caution.
244+
It can be used to prevent the benchmark from getting disrupted by the optimizer
245+
kicking in halfway through. However, this could result in a less effective
246+
optimization. In general, only use it if you know what it actually does.

0 commit comments

Comments
 (0)