[docgen] Update doc/telescope-file-browser.txt

skip-checks: true
nvim-telescope · Jan 17, 2022 · 1f7882b · 1f7882b
1 parent a5c31e3
commit 1f7882b
Showing 1 changed file with 32 additions and 30 deletions.
diff --git a/doc/telescope-file-browser.txt b/doc/telescope-file-browser.txt
@@ -49,7 +49,13 @@ https://github.com/nvim-telescope/telescope-file-browser.nvim
 ================================================================================
                                                  *telescope-file-browser.picker*
 
-fb_picker.file_browser({opts})                      *fb_picker.file_browser()*
+(default: { "directory" })
+---@field browse_files function: custom override for the file browser (default: |fb_finders.browse_files|)
+---@field browse_folders function: custom override for the folder browser (default: |fb_finders.browse_folders|)
+fb_picker.file_browser({opts}) *(default: { "directory" })
+---@field browse_files function: custom override for the file browser (default: |fb_finders.browse_files|)
+---@field browse_folders function: custom override for the folder browser (default: |fb_finders.browse_folders|)
+fb_picker.file_browser()*
     List, create, delete, rename, or move files and folders of your cwd.
     Default keymaps in insert/normal mode:
       - `<cr>`: opens the currently selected file, or navigates to the
@@ -74,35 +80,31 @@ fb_picker.file_browser({opts})                      *fb_picker.file_browser()*
         {opts} (table)  options to pass to the picker
 
     Fields: ~
-        {path}              (string)    dir to browse files from from,
-                                        `vim.fn.expanded` automatically
-                                        (default: vim.loop.cwd())
-        {cwd}               (string)    dir to browse folders from,
-                                        `vim.fn.expanded` automatically
-                                        (default: vim.loop.cwd())
-        {cwd_to_path}       (boolean)   whether folder browser is launched
-                                        from `path` rather than `cwd`
-                                        (default: false)
-        {grouped}           (boolean)   group initial sorting by directories
-                                        and then files; uses plenary.scandir
-                                        (default: false)
-        {files}             (boolean)   start in file (true) or folder (false)
-                                        browser (default: true)
-        {add_dirs}          (boolean)   whether the file browser shows folders
-                                        (default: true)
-        {depth}             (number)    file tree depth to display, `false`
-                                        for unlimited depth (default: 1)
-        {dir_icon}          (string)    change the icon for a directory
-                                        (default: )
-        {hidden}            (boolean)   determines whether to show hidden
-                                        files or not (default: false)
-        {respect_gitignore} (boolean)   induces slow-down w/ plenary finder
-                                        (default: false, true if `fd`
-                                        available)
-        {browse_files}      (function)  custom override for the file browser
-                                        (default: |fb_finders.browse_files|)
-        {browse_folders}    (function)  custom override for the folder browser
-                                        (default: |fb_finders.browse_folders|)
+        {path}              (string)   dir to browse files from from,
+                                       `vim.fn.expanded` automatically
+                                       (default: vim.loop.cwd())
+        {cwd}               (string)   dir to browse folders from,
+                                       `vim.fn.expanded` automatically
+                                       (default: vim.loop.cwd())
+        {cwd_to_path}       (boolean)  whether folder browser is launched from
+                                       `path` rather than `cwd` (default:
+                                       false)
+        {grouped}           (boolean)  group initial sorting by directories
+                                       and then files; uses plenary.scandir
+                                       (default: false)
+        {files}             (boolean)  start in file (true) or folder (false)
+                                       browser (default: true)
+        {add_dirs}          (boolean)  whether the file browser shows folders
+                                       (default: true)
+        {depth}             (number)   file tree depth to display, `false` for
+                                       unlimited depth (default: 1)
+        {dir_icon}          (string)   change the icon for a directory
+                                       (default: )
+        {hidden}            (boolean)  determines whether to show hidden files
+                                       or not (default: false)
+        {respect_gitignore} (boolean)  induces slow-down w/ plenary finder
+                                       (default: false, true if `fd`
+                                       available)