Fix documentation for brace escapes

sharkdp · Aug 9, 2023 · 231aea2 · 231aea2
1 parent 9ece7ba
commit 231aea2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/doc/fd.1 b/doc/fd.1
@@ -376,14 +376,16 @@ parent directory
 path without file extension
 .IP {/.}
 basename without file extension
-.IP {{}
-literal '{'
+.IP {{
+literal '{' (an escape sequence)
+.IP }}
+literal '}' (an escape sequence)
 .RE
 
 If no placeholder is present, an implicit "{}" at the end is assumed.
 
-If you need to include the literal text of one of the placeholders, you can use "{{}" to
-escape the first "{". For example "{{}}" expands to "{}", and "{{}{{}}}" expands to "{{}".
+Notice that you can use "{{" and "}}" to escape "{" and "}" respectively, which is especially
+useful if you need to include the literal text of one of the above placeholders.
 
 Examples:
 

diff --git a/src/cli.rs b/src/cli.rs
@@ -800,7 +800,8 @@ impl clap::Args for Exec {
                        '{//}': parent directory\n  \
                        '{.}':  path without file extension\n  \
                        '{/.}': basename without file extension\n  \
-                       '{{}':  literal '{' (for escaping)\n\n\
+                       '{{':   literal '{' (for escaping)\n  \
+                       '}}':   literal '}' (for escaping)\n\n\
                      If no placeholder is present, an implicit \"{}\" at the end is assumed.\n\n\
                      Examples:\n\n  \
                        - find all *.zip files and unzip them:\n\n      \