add a bit more docstring to INTERRUPTED

1 files changed, 6 insertions, 0 deletions

diff --git a/src/main.rs b/src/main.rs
index 0a98c4e..ad35d20 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -227,6 +227,12 @@ impl std::error::Error for InputError {}
 
 /// A flag that indicates whether the current search should be interrupted because the user pressed
 /// Crtl-C.
+///
+/// This flag can be set to `true` by signal handlers in order to exit the search as early as
+/// possible. Note that the search won't be exited immediately, as any logs currently in the
+/// process of being parsed will finish to do so.
+///
+/// The flag is automatically reset to `false` by the repl.
 static INTERRUPTED: AtomicBool = AtomicBool::new(false);
 
 fn main() {