Skip to content

Commit

Permalink
docs: add summary to Escaping
Browse files Browse the repository at this point in the history
The one-liners on the fields weren't quite sufficient for clarity. I was
going to add a few examples but then I couldn't decide how I wanted to
write them so I'm kicking that can down the road for now.
  • Loading branch information
dznz authored and flaviusb committed Sep 12, 2024
1 parent a9c302b commit 085c204
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion do_with_in_base/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,13 @@ impl Default for Sigil {
}

/// Escape sequence style set in [Configuration].
///
/// Sigils that precede a name or number, or a group are evaluated as variables and handlers respectively. To treat these sigils
/// instead as unchanged parts of a token an escape sequence can be used. Sigils that do not directly precede a name, number, or
/// group are always left unchanged.
#[derive(Debug,Copy,Clone,PartialEq,Eq)]
pub enum Escaping {
/// No escape sequence is allowed.
/// There are no escape sequences; sigils are always treated normally.
None,
/// Escape sequence is a backslash followed by a sigil e.g. `\%` or `\#`.
Backslash,
Expand Down

0 comments on commit 085c204

Please sign in to comment.