From d7f09f58954495d1373f3a400596b2fed71a8d1c Mon Sep 17 00:00:00 2001 From: Jack DeVries Date: Sat, 30 Oct 2021 09:30:39 -0400 Subject: [PATCH] doc: clarify quickfixlist abbreviation in README (#1392) This really killed me when I was looking at this plugin for the first time. I spent like 20 minutes googling how to get search results into the quickfixlist because ctrl-F for "quickfixlist" on the README yielded no results! There's nothing wrong with using the abbreviation in some places, but it should appear at least once in the form of `abbreviation (abbr.)`. That is, spelling it out next to the abbreviation at least once shows the reader the abbreviation they can search for next to learn more. --- README.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 7f1d902..3851384 100644 --- a/README.md +++ b/README.md @@ -189,27 +189,27 @@ EOF Mappings are fully customizable. Many familiar mapping patterns are setup as defaults. -| Mappings | Action | -|----------------|---------------------------------------------| -| `/` | Next item | -| `/` | Previous item | -| `j/k` | Next/previous (in normal mode) | -| `H/M/L` | Select High/Middle/Low (in normal mode) | -| 'gg/G' | Select the first/last item (in normal mode) | -| `` | Confirm selection | -| `` | Go to file selection as a split | -| `` | Go to file selection as a vsplit | -| `` | Go to a file in a new tab | -| `` | Scroll up in preview window | -| `` | Scroll down in preview window | -| `` | Show mappings for picker actions (insert mode)| -| `?` | Show mappings for picker actions (normal mode)| -| `` | Close telescope | -| `` | Close telescope (in normal mode) | -| `` | Toggle selection and move to next selection | -| `` | Toggle selection and move to prev selection | -| `` | Send all items not filtered to qflist | -| `` | Send all selected items to qflist | +| Mappings | Action | +|----------------|------------------------------------------------------| +| `/` | Next item | +| `/` | Previous item | +| `j/k` | Next/previous (in normal mode) | +| `H/M/L` | Select High/Middle/Low (in normal mode) | +| 'gg/G' | Select the first/last item (in normal mode) | +| `` | Confirm selection | +| `` | Go to file selection as a split | +| `` | Go to file selection as a vsplit | +| `` | Go to a file in a new tab | +| `` | Scroll up in preview window | +| `` | Scroll down in preview window | +| `` | Show mappings for picker actions (insert mode) | +| `?` | Show mappings for picker actions (normal mode) | +| `` | Close telescope | +| `` | Close telescope (in normal mode) | +| `` | Toggle selection and move to next selection | +| `` | Toggle selection and move to prev selection | +| `` | Send all items not filtered to quickfixlist (qflist) | +| `` | Send all selected items to qflist | To see the full list of mappings, check out `lua/telescope/mappings.lua` and the