From c8f23accd6775db3491eb1f310fe7c20a33677c1 Mon Sep 17 00:00:00 2001
From: Andy Gayton <andy@thecablelounge.com>
Date: Thu, 1 Aug 2024 12:56:58 -0400
Subject: [PATCH] wip

---
 crates/nu-plugin/src/plugin/interface/mod.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/crates/nu-plugin/src/plugin/interface/mod.rs b/crates/nu-plugin/src/plugin/interface/mod.rs
index 300ff6e496..f3f761b611 100644
--- a/crates/nu-plugin/src/plugin/interface/mod.rs
+++ b/crates/nu-plugin/src/plugin/interface/mod.rs
@@ -64,7 +64,8 @@ struct EngineInterfaceState {
         mpsc::Sender<(EngineCallId, mpsc::Sender<EngineCallResponse<PipelineData>>)>,
     /// The synchronized output writer
     writer: Box<dyn PluginWrite<PluginOutput>>,
-    // Mirror signals from `EngineState`
+    /// Mirror signals from `EngineState`. You can make use of this with
+    /// `engine_interface.signals()` when constructing a Stream that requires signals
     signals: Signals,
     /// Registered signal handlers
     signal_handlers: Handlers,