From 216df97453d92a64f1186242fdeca936a5e51cc5 Mon Sep 17 00:00:00 2001 From: Andy Gayton Date: Sat, 3 Aug 2024 15:07:49 -0400 Subject: [PATCH] upload comments --- crates/nu-plugin-engine/src/interface/mod.rs | 2 +- crates/nu-plugin-engine/src/persistent.rs | 2 +- crates/nu-plugin/src/plugin/interface/mod.rs | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/crates/nu-plugin-engine/src/interface/mod.rs b/crates/nu-plugin-engine/src/interface/mod.rs index 0fe4aee1eb..b27ea0be3d 100644 --- a/crates/nu-plugin-engine/src/interface/mod.rs +++ b/crates/nu-plugin-engine/src/interface/mod.rs @@ -664,7 +664,7 @@ impl PluginInterface { self.flush() } - /// Send the plugin a ctrl-c signal. + /// Send the plugin a signal. pub fn signal(&self, action: SignalAction) -> Result<(), ShellError> { self.write(PluginInput::Signal(action))?; self.flush() diff --git a/crates/nu-plugin-engine/src/persistent.rs b/crates/nu-plugin-engine/src/persistent.rs index 943e4dad7d..f9dcc5143b 100644 --- a/crates/nu-plugin-engine/src/persistent.rs +++ b/crates/nu-plugin-engine/src/persistent.rs @@ -310,7 +310,7 @@ impl RegisteredPlugin for PersistentPlugin { // RAII guard that will be stored on the plugin. let plugin = Arc::downgrade(&self); handlers.register(Box::new(move |action| { - // write a Ctrl-C packet through the PluginInterface if the plugin is alive and + // write a signal packet through the PluginInterface if the plugin is alive and // running if let Some(plugin) = plugin.upgrade() { if let Ok(mutable) = plugin.mutable.lock() { diff --git a/crates/nu-plugin/src/plugin/interface/mod.rs b/crates/nu-plugin/src/plugin/interface/mod.rs index f3f761b611..fc40b9c732 100644 --- a/crates/nu-plugin/src/plugin/interface/mod.rs +++ b/crates/nu-plugin/src/plugin/interface/mod.rs @@ -525,8 +525,8 @@ impl EngineInterface { self.state.writer.is_stdout() } - /// Register a closure which will be called when the engine receives a Ctrl-C signal. Returns a - /// RAII guard that will keep the closure alive until it is dropped. + /// Register a closure which will be called when the engine receives an interrupt signal. + /// Returns a RAII guard that will keep the closure alive until it is dropped. pub fn register_signal_handler(&self, handler: Handler) -> Result { self.state.signal_handlers.register(handler) }