doc: the error message

flowr-analysis · Sep 1, 2023 · 1e39329 · 1e39329
1 parent 275ee2b
commit 1e39329
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/cli/repl/server/messages/error.ts b/src/cli/repl/server/messages/error.ts
@@ -1,8 +1,12 @@
 import { FlowrBaseMessage } from './messages'
 
+/**
+ * Sent in case of any error (e.g., if the analysis fails, or the message contains syntax errors).
+ */
 export interface FlowrErrorMessage extends FlowrBaseMessage {
 	type:   'error',
 	/** if fatal, the connection will be partially closed afterward */
 	fatal:  boolean,
+	/** the human-readable reason for the error */
 	reason: string
 }