doc: put documentation of icon config parameters in correct place

namnd · Apr 11, 2023 · 54af7e0 · 54af7e0
1 parent f6d2102
commit 54af7e0
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 6 deletions.
diff --git a/.github/generate.py b/.github/generate.py
@@ -100,7 +100,11 @@ class ColumnDef:
         "*",
         False,
         "An icon for the entry's type (requires nvim-web-devicons)",
-        HL + [],
+        HL
+        + [
+            LuaParam("default_file", "string", "Fallback icon for files when nvim-web-devicons returns nil"),
+            LuaParam("directory", "string", "Icon for directories"),
+        ],
     ),
     ColumnDef("size", "files, ssh", False, "The size of the file", HL + []),
     ColumnDef(

diff --git a/README.md b/README.md
@@ -112,7 +112,7 @@ require("oil").setup({
   -- Id is automatically added at the beginning, and name at the end
   -- See :help oil-columns
   columns = {
-    { "icon", default_file = "", directory = " " },
+    "icon",
     -- "permissions",
     -- "size",
     -- "mtime",

diff --git a/doc/oil.txt b/doc/oil.txt
@@ -17,7 +17,7 @@ OPTIONS                                                              *oil-option
       -- Id is automatically added at the beginning, and name at the end
       -- See :help oil-columns
       columns = {
-        { "icon", default_file = "", directory = " " },
+        "icon",
         -- "permissions",
         -- "size",
         -- "mtime",
@@ -218,8 +218,11 @@ icon                                                                 *column-ico
     An icon for the entry's type (requires nvim-web-devicons)
 
     Parameters:
-      {highlight} `string|fun(value: string): string` Highlight group, or
-                  function that returns a highlight group
+      {highlight}    `string|fun(value: string): string` Highlight group, or
+                     function that returns a highlight group
+      {default_file} `string` Fallback icon for files when nvim-web-devicons
+                     returns nil
+      {directory}    `string` Icon for directories
 
 size                                                                 *column-size*
     Adapters: files, ssh

diff --git a/lua/oil/config.lua b/lua/oil/config.lua
@@ -2,7 +2,7 @@ local default_config = {
   -- Id is automatically added at the beginning, and name at the end
   -- See :help oil-columns
   columns = {
-    { "icon", default_file = "", directory = " " },
+    "icon",
     -- "permissions",
     -- "size",
     -- "mtime",