Skip to content

Commit eb9f27d

Browse files
alex-courtisalex-courtis
committed
docs(#2934): snake case config sections
1 parent c11308b commit eb9f27d

File tree

2 files changed

+44
-44
lines changed

2 files changed

+44
-44
lines changed

‎doc/nvim-tree-lua.txt‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2116,7 +2116,7 @@ Example of function that can be passed: >lua
21162116
<
21172117

21182118
==============================================================================
2119-
Class: Config *nvim-tree-config*
2119+
class: config *nvim-tree-config*
21202120

21212121
*nvim_tree.config*
21222122
Arguments to pass to |nvim-tree-setup|.
@@ -2236,7 +2236,7 @@ Class: Config *nvim-tree-config*
22362236

22372237

22382238
==============================================================================
2239-
Class: Config.Sort *nvim-tree-config-sort*
2239+
class: config.sort *nvim-tree-config-sort*
22402240

22412241
*nvim_tree.config.sort*
22422242
Sort files within a directory.
@@ -2276,7 +2276,7 @@ Class: Config.Sort *nvim-tree-config-sort*
22762276

22772277

22782278
==============================================================================
2279-
Class: Config.View *nvim-tree-config-view*
2279+
class: config.view *nvim-tree-config-view*
22802280

22812281
*nvim_tree.config.view*
22822282
Configures the dimensions and appearance of the nvim-tree window.
@@ -2362,7 +2362,7 @@ Class: Config.View *nvim-tree-config-view*
23622362

23632363

23642364
==============================================================================
2365-
Class: Config.Renderer *nvim-tree-config-renderer*
2365+
class: config.renderer *nvim-tree-config-renderer*
23662366

23672367
*nvim_tree.config.renderer*
23682368
Controls the appearance of the tree.
@@ -2538,7 +2538,7 @@ Class: Config.Renderer *nvim-tree-config-renderer*
25382538

25392539

25402540
==============================================================================
2541-
Class: Config.HijackDirectories *nvim-tree-config-hijack-directories*
2541+
class: config.hijack_directories *nvim-tree-config-hijack-directories*
25422542

25432543
*nvim_tree.config.hijack_directories*
25442544
Hijack directory buffers by replacing the directory buffer with the tree.
@@ -2556,7 +2556,7 @@ Class: Config.HijackDirectories *nvim-tree-config-hijack-directories*
25562556

25572557

25582558
==============================================================================
2559-
Class: Config.UpdateFocusedFile *nvim-tree-config-update-focused-file*
2559+
class: config.update_focused_file *nvim-tree-config-update-focused-file*
25602560

25612561
*nvim_tree.config.update_focused_file*
25622562
Update the focused file on |BufEnter|, uncollapsing folders recursively.
@@ -2588,7 +2588,7 @@ Class: Config.UpdateFocusedFile *nvim-tree-config-update-focused-file*
25882588

25892589

25902590
==============================================================================
2591-
Class: Config.SystemOpen *nvim-tree-config-system-open*
2591+
class: config.system_open *nvim-tree-config-system-open*
25922592

25932593
*nvim_tree.config.system_open*
25942594
Open files or directories via the OS.
@@ -2612,7 +2612,7 @@ Class: Config.SystemOpen *nvim-tree-config-system-open*
26122612

26132613

26142614
==============================================================================
2615-
Class: Config.Git *nvim-tree-config-git*
2615+
class: config.git *nvim-tree-config-git*
26162616

26172617
*nvim_tree.config.git*
26182618
Git operations are run in the background thus status may not immediately
@@ -2646,7 +2646,7 @@ Class: Config.Git *nvim-tree-config-git*
26462646

26472647

26482648
==============================================================================
2649-
Class: Config.Diagnostics *nvim-tree-config-diagnostics*
2649+
class: config.diagnostics *nvim-tree-config-diagnostics*
26502650

26512651
*nvim_tree.config.diagnostics*
26522652
Integrate with |lsp| or COC diagnostics.
@@ -2680,7 +2680,7 @@ Class: Config.Diagnostics *nvim-tree-config-diagnostics*
26802680

26812681

26822682
==============================================================================
2683-
Class: Config.Modified *nvim-tree-config-modified*
2683+
class: config.modified *nvim-tree-config-modified*
26842684

26852685
*nvim_tree.config.modified*
26862686
Indicate which files have unsaved modification. To see modified status in
@@ -2702,7 +2702,7 @@ Class: Config.Modified *nvim-tree-config-modified*
27022702

27032703

27042704
==============================================================================
2705-
Class: Config.Filters *nvim-tree-config-filters*
2705+
class: config.filters *nvim-tree-config-filters*
27062706

27072707
*nvim_tree.config.filters*
27082708
Filters may be applied to the tree to exlude the display of
@@ -2757,7 +2757,7 @@ Class: Config.Filters *nvim-tree-config-filters*
27572757

27582758

27592759
==============================================================================
2760-
Class: Config.LiveFilter *nvim-tree-config-live-filter*
2760+
class: config.live_filter *nvim-tree-config-live-filter*
27612761

27622762
*nvim_tree.config.live_filter*
27632763
Live filter allows you to filter the tree nodes dynamically, based on
@@ -2775,7 +2775,7 @@ Class: Config.LiveFilter *nvim-tree-config-live-filter*
27752775

27762776

27772777
==============================================================================
2778-
Class: Config.FilesystemWatchers *nvim-tree-config-filesystem-watchers*
2778+
class: config.filesystem_watchers *nvim-tree-config-filesystem-watchers*
27792779

27802780
*nvim_tree.config.filesystem_watchers*
27812781
Use file system watchers (libuv `uv_fs_event_t`) to monitor the filesystem
@@ -2801,7 +2801,7 @@ Class: Config.FilesystemWatchers *nvim-tree-config-filesystem-watchers*
28012801

28022802

28032803
==============================================================================
2804-
Class: Config.Actions *nvim-tree-config-actions*
2804+
class: config.actions *nvim-tree-config-actions*
28052805

28062806
*nvim_tree.config.actions*
28072807

@@ -2924,7 +2924,7 @@ Class: Config.Actions *nvim-tree-config-actions*
29242924

29252925

29262926
==============================================================================
2927-
Class: Config.Trash *nvim-tree-config-trash*
2927+
class: config.trash *nvim-tree-config-trash*
29282928

29292929
*nvim_tree.config.trash*
29302930
Files may be trashed via an external command that must be installed on
@@ -2939,7 +2939,7 @@ Class: Config.Trash *nvim-tree-config-trash*
29392939

29402940

29412941
==============================================================================
2942-
Class: Config.Tab *nvim-tree-config-tab*
2942+
class: config.tab *nvim-tree-config-tab*
29432943

29442944
*nvim_tree.config.tab*
29452945

@@ -2960,7 +2960,7 @@ Class: Config.Tab *nvim-tree-config-tab*
29602960

29612961

29622962
==============================================================================
2963-
Class: Config.Notify *nvim-tree-config-notify*
2963+
class: config.notify *nvim-tree-config-notify*
29642964

29652965
*nvim_tree.config.notify*
29662966
nvim-tree |vim.log.levels|
@@ -2979,7 +2979,7 @@ Class: Config.Notify *nvim-tree-config-notify*
29792979

29802980

29812981
==============================================================================
2982-
Class: Config.Bookmarks *nvim-tree-config-bookmarks*
2982+
class: config.bookmarks *nvim-tree-config-bookmarks*
29832983

29842984
*nvim_tree.config.bookmarks*
29852985
Optionally {persist} bookmarks to a json file:
@@ -2993,7 +2993,7 @@ Class: Config.Bookmarks *nvim-tree-config-bookmarks*
29932993

29942994

29952995
==============================================================================
2996-
Class: Config.Help *nvim-tree-config-help*
2996+
class: config.help *nvim-tree-config-help*
29972997

29982998
*nvim_tree.config.help*
29992999

@@ -3003,7 +3003,7 @@ Class: Config.Help *nvim-tree-config-help*
30033003

30043004

30053005
==============================================================================
3006-
Class: Config.UI *nvim-tree-config-ui*
3006+
class: config.ui *nvim-tree-config-ui*
30073007

30083008
*nvim_tree.config.ui*
30093009

@@ -3023,7 +3023,7 @@ Class: Config.UI *nvim-tree-config-ui*
30233023

30243024

30253025
==============================================================================
3026-
Class: Config.Experimental *nvim-tree-config-experimental*
3026+
class: config.experimental *nvim-tree-config-experimental*
30273027

30283028
*nvim_tree.config.experimental*
30293029
Experimental features that may become default or optional functionality.
@@ -3034,7 +3034,7 @@ Class: Config.Experimental *nvim-tree-config-experimental*
30343034

30353035

30363036
==============================================================================
3037-
Class: Config.Log *nvim-tree-config-log*
3037+
class: config.log *nvim-tree-config-log*
30383038

30393039
*nvim_tree.config.log*
30403040
Log to a file `nvim-tree.log` in |stdpath()| `log`, usually

‎scripts/gen_vimdoc_config.lua‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,28 @@
88
---Help txt is deleted from first tag down and generated content is appended.
99
---@type Src[]
1010
local srcs = {
11-
{ helptag = "nvim-tree-config", section = "Class: Config", path = "./lua/nvim_tree/_meta/config.lua", },
12-
{ helptag = "nvim-tree-config-sort", section = "Class: Config.Sort", path = "./lua/nvim_tree/_meta/config/sort.lua", },
13-
{ helptag = "nvim-tree-config-view", section = "Class: Config.View", path = "./lua/nvim_tree/_meta/config/view.lua", },
14-
{ helptag = "nvim-tree-config-renderer", section = "Class: Config.Renderer", path = "./lua/nvim_tree/_meta/config/renderer.lua", },
15-
{ helptag = "nvim-tree-config-hijack-directories", section = "Class: Config.HijackDirectories", path = "./lua/nvim_tree/_meta/config/hijack_directories.lua", },
16-
{ helptag = "nvim-tree-config-update-focused-file", section = "Class: Config.UpdateFocusedFile", path = "./lua/nvim_tree/_meta/config/update_focused_file.lua", },
17-
{ helptag = "nvim-tree-config-system-open", section = "Class: Config.SystemOpen", path = "./lua/nvim_tree/_meta/config/system_open.lua", },
18-
{ helptag = "nvim-tree-config-git", section = "Class: Config.Git", path = "./lua/nvim_tree/_meta/config/git.lua", },
19-
{ helptag = "nvim-tree-config-diagnostics", section = "Class: Config.Diagnostics", path = "./lua/nvim_tree/_meta/config/diagnostics.lua", },
20-
{ helptag = "nvim-tree-config-modified", section = "Class: Config.Modified", path = "./lua/nvim_tree/_meta/config/modified.lua", },
21-
{ helptag = "nvim-tree-config-filters", section = "Class: Config.Filters", path = "./lua/nvim_tree/_meta/config/filters.lua", },
22-
{ helptag = "nvim-tree-config-live-filter", section = "Class: Config.LiveFilter", path = "./lua/nvim_tree/_meta/config/live_filter.lua", },
23-
{ helptag = "nvim-tree-config-filesystem-watchers", section = "Class: Config.FilesystemWatchers", path = "./lua/nvim_tree/_meta/config/filesystem_watchers.lua", },
24-
{ helptag = "nvim-tree-config-actions", section = "Class: Config.Actions", path = "./lua/nvim_tree/_meta/config/actions.lua", },
25-
{ helptag = "nvim-tree-config-trash", section = "Class: Config.Trash", path = "./lua/nvim_tree/_meta/config/trash.lua", },
26-
{ helptag = "nvim-tree-config-tab", section = "Class: Config.Tab", path = "./lua/nvim_tree/_meta/config/tab.lua", },
27-
{ helptag = "nvim-tree-config-notify", section = "Class: Config.Notify", path = "./lua/nvim_tree/_meta/config/notify.lua", },
28-
{ helptag = "nvim-tree-config-bookmarks", section = "Class: Config.Bookmarks", path = "./lua/nvim_tree/_meta/config/bookmarks.lua", },
29-
{ helptag = "nvim-tree-config-help", section = "Class: Config.Help", path = "./lua/nvim_tree/_meta/config/help.lua", },
30-
{ helptag = "nvim-tree-config-ui", section = "Class: Config.UI", path = "./lua/nvim_tree/_meta/config/ui.lua", name = "UI", },
31-
{ helptag = "nvim-tree-config-experimental", section = "Class: Config.Experimental", path = "./lua/nvim_tree/_meta/config/experimental.lua", },
32-
{ helptag = "nvim-tree-config-log", section = "Class: Config.Log", path = "./lua/nvim_tree/_meta/config/log.lua", },
11+
{ helptag = "nvim-tree-config", section = "class: config", path = "./lua/nvim_tree/_meta/config.lua", },
12+
{ helptag = "nvim-tree-config-sort", section = "class: config.sort", path = "./lua/nvim_tree/_meta/config/sort.lua", },
13+
{ helptag = "nvim-tree-config-view", section = "class: config.view", path = "./lua/nvim_tree/_meta/config/view.lua", },
14+
{ helptag = "nvim-tree-config-renderer", section = "class: config.renderer", path = "./lua/nvim_tree/_meta/config/renderer.lua", },
15+
{ helptag = "nvim-tree-config-hijack-directories", section = "class: config.hijack_directories", path = "./lua/nvim_tree/_meta/config/hijack_directories.lua", },
16+
{ helptag = "nvim-tree-config-update-focused-file", section = "class: config.update_focused_file", path = "./lua/nvim_tree/_meta/config/update_focused_file.lua", },
17+
{ helptag = "nvim-tree-config-system-open", section = "class: config.system_open", path = "./lua/nvim_tree/_meta/config/system_open.lua", },
18+
{ helptag = "nvim-tree-config-git", section = "class: config.git", path = "./lua/nvim_tree/_meta/config/git.lua", },
19+
{ helptag = "nvim-tree-config-diagnostics", section = "class: config.diagnostics", path = "./lua/nvim_tree/_meta/config/diagnostics.lua", },
20+
{ helptag = "nvim-tree-config-modified", section = "class: config.modified", path = "./lua/nvim_tree/_meta/config/modified.lua", },
21+
{ helptag = "nvim-tree-config-filters", section = "class: config.filters", path = "./lua/nvim_tree/_meta/config/filters.lua", },
22+
{ helptag = "nvim-tree-config-live-filter", section = "class: config.live_filter", path = "./lua/nvim_tree/_meta/config/live_filter.lua", },
23+
{ helptag = "nvim-tree-config-filesystem-watchers", section = "class: config.filesystem_watchers", path = "./lua/nvim_tree/_meta/config/filesystem_watchers.lua", },
24+
{ helptag = "nvim-tree-config-actions", section = "class: config.actions", path = "./lua/nvim_tree/_meta/config/actions.lua", },
25+
{ helptag = "nvim-tree-config-trash", section = "class: config.trash", path = "./lua/nvim_tree/_meta/config/trash.lua", },
26+
{ helptag = "nvim-tree-config-tab", section = "class: config.tab", path = "./lua/nvim_tree/_meta/config/tab.lua", },
27+
{ helptag = "nvim-tree-config-notify", section = "class: config.notify", path = "./lua/nvim_tree/_meta/config/notify.lua", },
28+
{ helptag = "nvim-tree-config-bookmarks", section = "class: config.bookmarks", path = "./lua/nvim_tree/_meta/config/bookmarks.lua", },
29+
{ helptag = "nvim-tree-config-help", section = "class: config.help", path = "./lua/nvim_tree/_meta/config/help.lua", },
30+
{ helptag = "nvim-tree-config-ui", section = "class: config.ui", path = "./lua/nvim_tree/_meta/config/ui.lua", name = "UI", },
31+
{ helptag = "nvim-tree-config-experimental", section = "class: config.experimental", path = "./lua/nvim_tree/_meta/config/experimental.lua", },
32+
{ helptag = "nvim-tree-config-log", section = "class: config.log", path = "./lua/nvim_tree/_meta/config/log.lua", },
3333
}
3434

3535
-- hydrate file names

0 commit comments

Comments
 (0)