src: update comment for SetImmediate()

addaleax · jasnell · commit 064a6703a720 · 2020-03-20T17:48:10.000-07:00
Refs: #31502 (comment) PR-URL: #32300 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
diff --git a/src/env.h b/src/env.h
@@ -1177,7 +1177,8 @@ class Environment : public MemoryRetainer {
   }
 
   // cb will be called as cb(env) on the next event loop iteration.
-  // keep_alive will be kept alive between now and after the callback has run.
+  // Unlike the JS setImmediate() function, nested SetImmediate() calls will
+  // be run without returning control to the event loop, similar to nextTick().
   template <typename Fn>
   inline void SetImmediate(Fn&& cb);
   template <typename Fn>

Original file line number	Diff line number	Diff line change
`@@ -1177,7 +1177,8 @@ class Environment : public MemoryRetainer {`
`1177`	`1177`	`}`
`1178`	`1178`
`1179`	`1179`	`// cb will be called as cb(env) on the next event loop iteration.`
`1180`		`- // keep_alive will be kept alive between now and after the callback has run.`
	`1180`	`+ // Unlike the JS setImmediate() function, nested SetImmediate() calls will`
	`1181`	`+ // be run without returning control to the event loop, similar to nextTick().`
`1181`	`1182`	`template <typename Fn>`
`1182`	`1183`	`inline void SetImmediate(Fn&& cb);`
`1183`	`1184`	`template <typename Fn>`