docs: clarify root_folder_label=false (not true) to disable, tidy nvim_tree_config.renderer help (#3286)

docs: root_folder_label=false to disable, tidy nvim_tree_config.renderer help

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -1231,9 +1231,11 @@ Config: renderer                                   *nvim-tree-config-renderer*
 
     Specify {decorators} is a list e.g. `{ "Git", MyDecorator, "Cut" }`
 
-    {root_folder_label} has 3 forms:
+    {root_folder_label}          *nvim_tree.config.renderer.root_folder_label*
+
+    Controls the root folder name and visibility:
     • `string`: |filename-modifiers| format string, default `":~:s?$?/..?"`
-    • `boolean`: `true` to disable
+    • `false`: to disable
     • `fun(root_cwd: string): string`: return a literal string from root's
       absolute path e.g. >lua
         my_root_folder_label = function(path)
@@ -1266,8 +1268,8 @@ Config: renderer                                   *nvim-tree-config-renderer*
       • {full_name}?               (`boolean`, default: `false`) Display nodes
                                    whose name length is wider than the width
                                    of nvim-tree window in floating window.
-      • {root_folder_label}?       (`string|boolean|(fun(root_cwd: string): string)`)
-                                   (default: `":~:s?$?/..?"`)
+      • {root_folder_label}?       (`nvim_tree.config.renderer.root_folder_label`, default: `":~:s?$?/..?"`)
+                                   |nvim_tree.config.renderer.root_folder_label|
       • {indent_width}?            (`integer`, default: `2`) Number of spaces
                                    for each tree nesting level. Minimum 1.
       • {hidden_display}?          (`nvim_tree.config.renderer.hidden_display`, default: `none`)

lua/nvim-tree/_meta/config/renderer.lua

@@ -39,15 +39,18 @@ error("Cannot require a meta file")
 ---
 ---
 ---
----{root_folder_label} has 3 forms:
+---{root_folder_label} [nvim_tree.config.renderer.root_folder_label]()
+---
+---Controls the root folder name and visibility:
 ---- `string`: [filename-modifiers] format string, default `":~:s?$?/..?"`
----- `boolean`: `true` to disable
+---- `false`: to disable
 ---- `fun(root_cwd: string): string`: return a literal string from root's absolute path e.g.
 ---```lua
 --- my_root_folder_label = function(path)
 ---   return ".../" .. vim.fn.fnamemodify(path, ":t")
 --- end
 ---```
+---@alias nvim_tree.config.renderer.root_folder_label string|false|(fun(root_cwd: string): string)
 ---
 ---
 ---
@@ -80,8 +83,9 @@ error("Cannot require a meta file")
 ---(default: `false`)
 ---@field full_name? boolean
 ---
+---[nvim_tree.config.renderer.root_folder_label]
 ---(default: `":~:s?$?/..?"`)
----@field root_folder_label? string|boolean|(fun(root_cwd: string): string)
+---@field root_folder_label? nvim_tree.config.renderer.root_folder_label
 ---
 ---Number of spaces for each tree nesting level. Minimum 1.
 ---(default: `2`)