doc: put documentation of icon config parameters in correct place

This commit is contained in:
Steven Arcangeli 2023-04-11 08:28:03 -07:00
parent f6d2102e2b
commit 54af7e013d
4 changed files with 13 additions and 6 deletions

6
.github/generate.py vendored
View file

@ -100,7 +100,11 @@ COL_DEFS = [
"*", "*",
False, False,
"An icon for the entry's type (requires nvim-web-devicons)", "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("size", "files, ssh", False, "The size of the file", HL + []),
ColumnDef( ColumnDef(

View file

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

View file

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

View file

@ -2,7 +2,7 @@ local default_config = {
-- Id is automatically added at the beginning, and name at the end -- Id is automatically added at the beginning, and name at the end
-- See :help oil-columns -- See :help oil-columns
columns = { columns = {
{ "icon", default_file = "", directory = "" }, "icon",
-- "permissions", -- "permissions",
-- "size", -- "size",
-- "mtime", -- "mtime",