feat: Add ability to have a user defined function to format the path display (#1000)

1 files changed, 9 insertions, 0 deletions

diff --git a/doc/telescope.txt b/doc/telescope.txt
index 06815c8..bdd25b3 100644
--- a/doc/telescope.txt
+++ b/doc/telescope.txt
@@ -181,6 +181,15 @@ telescope.setup({opts})                                    *telescope.setup()*
 
         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
+        the path display. Example:
+
+            -- Format path as "file.txt (path\to\file\)"
+            path_display = function(opts, path)
+              local tail = require("telescope.utils").path_tail(path)
+              return string.format("%s (%s)", tail, path)
+            end,
+
         Default: {}
 
                                          *telescope.defaults.prompt_prefix*