From 11650c683eccada148e2f10c02219898c9d375cb Mon Sep 17 00:00:00 2001
From: Anna Henningsen <anna@addaleax.net>
Date: Mon, 16 Mar 2020 12:25:21 +0100
Subject: [PATCH] src: update comment for SetImmediate()

Refs: https://github.com/nodejs/node/pull/31502#issuecomment-599242824

PR-URL: https://github.com/nodejs/node/pull/32300
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
---
 src/env.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/env.h b/src/env.h
index 579d0f547e4bdc..0351af5dea0491 100644
--- a/src/env.h
+++ b/src/env.h
@@ -1171,7 +1171,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>