From d1a2923d7236feec82c23937a7ed357454a09659 Mon Sep 17 00:00:00 2001
From: Mahmoud Al-Qudsi <mqudsi@neosmart.net>
Date: Mon, 4 Nov 2024 15:49:33 -0600
Subject: [PATCH] Fix doc comments for CancelBehavior

---
 src/parser.rs | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/src/parser.rs b/src/parser.rs
index 57423e596..bb79f0139 100644
--- a/src/parser.rs
+++ b/src/parser.rs
@@ -357,14 +357,16 @@ pub enum ParserStatusVar {
 
 pub type BlockId = usize;
 
-// Controls the behavior when fish itself receives a signal and there are
-// no blocks on the stack.
-// The "outermost" parser is responsible for clearing the signal.
+/// Controls the behavior when fish itself receives a signal and there are
+/// no blocks on the stack.
+/// The "outermost" parser is responsible for clearing the signal.
 #[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
 pub enum CancelBehavior {
     #[default]
-    Return, // Return the signal to the caller.
-    Clear, // Clear the signal.
+    /// Return the signal to the caller
+    Return,
+    /// Clear the signal
+    Clear,
 }
 
 pub struct Parser {