From 4dfa2d6f9aacd95f906891acc4e268bcdf573ec8 Mon Sep 17 00:00:00 2001
From: Igor <ig_@tutamail.com>
Date: Sun, 13 Oct 2024 11:09:54 +0400
Subject: [PATCH] docs: add a note about `impl Future`

---
 brush-interactive/src/interactive_shell.rs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/brush-interactive/src/interactive_shell.rs b/brush-interactive/src/interactive_shell.rs
index 86361f11..84b0c7db 100644
--- a/brush-interactive/src/interactive_shell.rs
+++ b/brush-interactive/src/interactive_shell.rs
@@ -53,6 +53,7 @@ pub trait InteractiveShell {
     /// Runs the interactive shell loop, reading commands from standard input and writing
     /// results to standard output and standard error. Continues until the shell
     /// normally exits or until a fatal error occurs.
+    // NOTE: we use desugared async here because [async_fn_in_trait] "warning: use of `async fn` in public traits is discouraged as auto trait bounds cannot be specified"
     fn run_interactively(&mut self) -> impl std::future::Future<Output = Result<(), ShellError>> {
         async {
             // TODO: Consider finding a better place for this.