summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLuke Kershaw <35707277+l-kershaw@users.noreply.github.com>2021-07-16 17:41:39 +0100
committerGitHub <noreply@github.com>2021-07-16 17:41:39 +0100
commit1866265feaebda2b615fadaa9230ec45958dd210 (patch)
treea3e7663b4f0f9fa00a3bc4d410063d8e914fa91b /doc
parent138697980b68ce7d4f0661c752691ffe5dbb72b0 (diff)
feat: Add length option for `shorten_path` (#886)
* feat: add `shorten_len` option for path shortening - adds option to configure the length of shortened parts of filenames - only affects paths when "shorten" is in `path_display` * chore: revert rebase for `path.lua` to 876bed9 * refactor: replace `shorten_len` with the `shorten` key in `path_display` - also deprecates `utils.path_shorten` and passes straight to `plenary`s `Path:shorten` * feat: allow `path_display` to handle table keys, as well as strings
Diffstat (limited to 'doc')
-rw-r--r--doc/telescope.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/telescope.txt b/doc/telescope.txt
index bdd25b3..7a12c95 100644
--- a/doc/telescope.txt
+++ b/doc/telescope.txt
@@ -179,6 +179,15 @@ telescope.setup({opts}) *telescope.setup()*
- "shorten" only display the first character of each directory in
the path
+ You can also specify the number of characters of each directory name
+ to keep by setting `path_display.shorten = num`.
+ e.g. for a path like
+ `alpha/beta/gamma/delta.txt`
+ setting `path_display.shorten = 1` will give a path like:
+ `a/b/g/delta.txt`
+ Similarly, `path_display.shorten = 2` will give a path like:
+ `al/be/ga/delta.txt`
+
path_display can also be set to 'hidden' string to hide file names
path_display can also be set to a function for custom formatting of