explain smart autoquote in README

nvim-telescope · Dec 19, 2022 · 6168c45 · 6168c45
1 parent 9415370
commit 6168c45
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -87,6 +87,16 @@ Call live grep args:
 If the prompt value does not begin with `'`, `"` or `-` the entire prompt is treated as a single argument.
 This behaviour can be turned off by setting the `auto_quoting` option to `false`.
 
+Setting the `auto_quoting` option to `smart` allows using `--` as a seperator before flags.
+The part before the seperator is taken as a single argument, and the part after is split.
+Again, if the prompt begins with `'`, `"` or `-`, this is disabled and control is manual.
+
+| prompt | args (smart mode) |
+| --- | --- |
+| `foo bar` | `foo bar` |
+| `foo bar -- --flag` | `foo bar`, `--flag` |
+| `"foo bar" baz --flag` | `foo bar`, `baz`, `--flag` |
+
 
 ## Configuration