Fix doc comments for CancelBehavior

This commit is contained in:
Mahmoud Al-Qudsi 2024-11-04 15:49:33 -06:00
parent 8aed929f5e
commit d1a2923d72

View file

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