Add a comment about the use of `shell_kind` in terminal.rs (#40114)

Cole Miller and Jakub Konka created 3 weeks ago

Release Notes:

- N/A

Co-authored-by: Jakub Konka <[e-mail]>

Change summary

crates/terminal/src/terminal.rs | 5 +++++
1 file changed, 5 insertions(+)

Detailed changes

crates/terminal/src/terminal.rs

@@ -495,6 +495,11 @@ impl TerminalBuilder {
                 .unwrap_or(params.program.clone())
         });
 
+        // Note: when remoting, this shell_kind will scrutinize `ssh` or
+        // `wsl.exe` as a shell and fall back to posix or powershell based on
+        // the compilation target. This is fine right now due to the restricted
+        // way we use the return value, but would become incorrect if we
+        // supported remoting into windows.
         let shell_kind = shell.shell_kind(cfg!(windows));
 
         let pty_options = {