From 085c204f760f113f208c20a2a7737c84d11a88e0 Mon Sep 17 00:00:00 2001 From: Daniel Zollinger Date: Thu, 12 Sep 2024 23:10:01 +1200 Subject: [PATCH] docs: add summary to Escaping 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. --- do_with_in_base/src/lib.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/do_with_in_base/src/lib.rs b/do_with_in_base/src/lib.rs index 67c2c89..c77d161 100644 --- a/do_with_in_base/src/lib.rs +++ b/do_with_in_base/src/lib.rs @@ -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,