errors: fix the comments for hideStackFrame

Fix the comments for the no-overhead hideStackFrame Refs: nodejs#35644
mmomtchev · Nov 24, 2020 · 865e2eb · 865e2eb
1 parent abf684c
commit 865e2eb
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 4 deletions.
diff --git a/benchmark/misc/hidestackframes.js b/benchmark/misc/hidestackframes.js
@@ -2,10 +2,6 @@
 
 const common = require('../common.js');
 
-/* there should be no significant performance differences
- * between the hideStackFrames version and the direct
- * call version
- */
 const bench = common.createBenchmark(main, {
   type: ['hide-stackframes-throw', 'direct-call-throw',
          'hide-stackframes-noerr', 'direct-call-noerr'],

diff --git a/lib/internal/errors.js b/lib/internal/errors.js
@@ -326,6 +326,8 @@ function makeNodeErrorWithCode(Base, key) {
 
 // This function removes unnecessary frames from Node.js core errors.
 function hideStackFrames(fn) {
+  // We rename the functions that will be hidden to cut off the stacktrace
+  // at the outermost one
   const hidden = '__node_internal_hidden_' + fn.name;
   ObjectDefineProperty(fn, 'name', { value: hidden });
   return fn;