Skip to content

Commit b9b75d3

Browse files
alex-courtisalex-courtis
committed
docs(#2934): remove class from config section headers
1 parent 595bc69 commit b9b75d3

File tree

3 files changed

+48
-48
lines changed

3 files changed

+48
-48
lines changed

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ help-update:
4444
# --ignore-blank-lines is used as nightly has removed unnecessary blank lines that stable (0.11.5) currently inserts
4545
#
4646
help-check: help-update
47-
git diff --ignore-blank-lines --exit-code doc/nvim-tree-lua.txt
4847
scripts/lintdoc.sh
48+
git diff --ignore-blank-lines --exit-code doc/nvim-tree-lua.txt
4949

5050

5151
.PHONY: all lint style check luacheck style-check style-doc luals style-fix help-update help-check

‎doc/nvim-tree-lua.txt‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1850,7 +1850,7 @@ Example of function that can be passed: >lua
18501850
<
18511851

18521852
==============================================================================
1853-
Class: config *nvim-tree-config*
1853+
Config *nvim-tree-config*
18541854

18551855
*nvim_tree.config*
18561856
Arguments to pass to |nvim-tree-setup|.
@@ -1956,7 +1956,7 @@ Class: config *nvim-tree-config*
19561956

19571957

19581958
==============================================================================
1959-
Class: config.sort *nvim-tree-config-sort*
1959+
Config: sort *nvim-tree-config-sort*
19601960

19611961
*nvim_tree.config.sort*
19621962
Sort files within a directory.
@@ -1996,7 +1996,7 @@ Class: config.sort *nvim-tree-config-sort*
19961996

19971997

19981998
==============================================================================
1999-
Class: config.view *nvim-tree-config-view*
1999+
Config: view *nvim-tree-config-view*
20002000

20012001
*nvim_tree.config.view*
20022002
Configures the dimensions and appearance of the nvim-tree window.
@@ -2082,7 +2082,7 @@ Class: config.view *nvim-tree-config-view*
20822082

20832083

20842084
==============================================================================
2085-
Class: config.renderer *nvim-tree-config-renderer*
2085+
Config: renderer *nvim-tree-config-renderer*
20862086

20872087
*nvim_tree.config.renderer*
20882088
Controls the appearance of the tree.
@@ -2258,7 +2258,7 @@ Class: config.renderer *nvim-tree-config-renderer*
22582258

22592259

22602260
==============================================================================
2261-
Class: config.hijack_directories *nvim-tree-config-hijack-directories*
2261+
Config: hijack_directories *nvim-tree-config-hijack-directories*
22622262

22632263
*nvim_tree.config.hijack_directories*
22642264
Hijack directory buffers by replacing the directory buffer with the tree.
@@ -2276,7 +2276,7 @@ Class: config.hijack_directories *nvim-tree-config-hijack-directories*
22762276

22772277

22782278
==============================================================================
2279-
Class: config.update_focused_file *nvim-tree-config-update-focused-file*
2279+
Config: update_focused_file *nvim-tree-config-update-focused-file*
22802280

22812281
*nvim_tree.config.update_focused_file*
22822282
Update the focused file on |BufEnter|, uncollapsing folders recursively.
@@ -2308,7 +2308,7 @@ Class: config.update_focused_file *nvim-tree-config-update-focused-file*
23082308

23092309

23102310
==============================================================================
2311-
Class: config.system_open *nvim-tree-config-system-open*
2311+
Config: system_open *nvim-tree-config-system-open*
23122312

23132313
*nvim_tree.config.system_open*
23142314
Open files or directories via the OS.
@@ -2332,7 +2332,7 @@ Class: config.system_open *nvim-tree-config-system-open*
23322332

23332333

23342334
==============================================================================
2335-
Class: config.git *nvim-tree-config-git*
2335+
Config: git *nvim-tree-config-git*
23362336

23372337
*nvim_tree.config.git*
23382338
Git operations are run in the background thus status may not immediately
@@ -2366,7 +2366,7 @@ Class: config.git *nvim-tree-config-git*
23662366

23672367

23682368
==============================================================================
2369-
Class: config.diagnostics *nvim-tree-config-diagnostics*
2369+
Config: diagnostics *nvim-tree-config-diagnostics*
23702370

23712371
*nvim_tree.config.diagnostics*
23722372
Integrate with |lsp| or COC diagnostics.
@@ -2400,7 +2400,7 @@ Class: config.diagnostics *nvim-tree-config-diagnostics*
24002400

24012401

24022402
==============================================================================
2403-
Class: config.modified *nvim-tree-config-modified*
2403+
Config: modified *nvim-tree-config-modified*
24042404

24052405
*nvim_tree.config.modified*
24062406
Indicate which files have unsaved modification. To see modified status in
@@ -2422,7 +2422,7 @@ Class: config.modified *nvim-tree-config-modified*
24222422

24232423

24242424
==============================================================================
2425-
Class: config.filters *nvim-tree-config-filters*
2425+
Config: filters *nvim-tree-config-filters*
24262426

24272427
*nvim_tree.config.filters*
24282428
Filters may be applied to the tree to exlude the display of
@@ -2477,7 +2477,7 @@ Class: config.filters *nvim-tree-config-filters*
24772477

24782478

24792479
==============================================================================
2480-
Class: config.live_filter *nvim-tree-config-live-filter*
2480+
Config: live_filter *nvim-tree-config-live-filter*
24812481

24822482
*nvim_tree.config.live_filter*
24832483
Live filter allows you to filter the tree nodes dynamically, based on
@@ -2495,7 +2495,7 @@ Class: config.live_filter *nvim-tree-config-live-filter*
24952495

24962496

24972497
==============================================================================
2498-
Class: config.filesystem_watchers *nvim-tree-config-filesystem-watchers*
2498+
Config: filesystem_watchers *nvim-tree-config-filesystem-watchers*
24992499

25002500
*nvim_tree.config.filesystem_watchers*
25012501
Use file system watchers (libuv `uv_fs_event_t`) to monitor the filesystem
@@ -2521,7 +2521,7 @@ Class: config.filesystem_watchers *nvim-tree-config-filesystem-watchers*
25212521

25222522

25232523
==============================================================================
2524-
Class: config.actions *nvim-tree-config-actions*
2524+
Config: actions *nvim-tree-config-actions*
25252525

25262526
*nvim_tree.config.actions*
25272527

@@ -2644,7 +2644,7 @@ Class: config.actions *nvim-tree-config-actions*
26442644

26452645

26462646
==============================================================================
2647-
Class: config.trash *nvim-tree-config-trash*
2647+
Config: trash *nvim-tree-config-trash*
26482648

26492649
*nvim_tree.config.trash*
26502650
Files may be trashed via an external command that must be installed on
@@ -2659,7 +2659,7 @@ Class: config.trash *nvim-tree-config-trash*
26592659

26602660

26612661
==============================================================================
2662-
Class: config.tab *nvim-tree-config-tab*
2662+
Config: tab *nvim-tree-config-tab*
26632663

26642664
*nvim_tree.config.tab*
26652665

@@ -2680,7 +2680,7 @@ Class: config.tab *nvim-tree-config-tab*
26802680

26812681

26822682
==============================================================================
2683-
Class: config.notify *nvim-tree-config-notify*
2683+
Config: notify *nvim-tree-config-notify*
26842684

26852685
*nvim_tree.config.notify*
26862686
nvim-tree |vim.log.levels|
@@ -2699,7 +2699,7 @@ Class: config.notify *nvim-tree-config-notify*
26992699

27002700

27012701
==============================================================================
2702-
Class: config.bookmarks *nvim-tree-config-bookmarks*
2702+
Config: bookmarks *nvim-tree-config-bookmarks*
27032703

27042704
*nvim_tree.config.bookmarks*
27052705
Optionally {persist} bookmarks to a json file:
@@ -2713,7 +2713,7 @@ Class: config.bookmarks *nvim-tree-config-bookmarks*
27132713

27142714

27152715
==============================================================================
2716-
Class: config.help *nvim-tree-config-help*
2716+
Config: help *nvim-tree-config-help*
27172717

27182718
*nvim_tree.config.help*
27192719

@@ -2723,7 +2723,7 @@ Class: config.help *nvim-tree-config-help*
27232723

27242724

27252725
==============================================================================
2726-
Class: config.ui *nvim-tree-config-ui*
2726+
Config: ui *nvim-tree-config-ui*
27272727

27282728
*nvim_tree.config.ui*
27292729

@@ -2743,7 +2743,7 @@ Class: config.ui *nvim-tree-config-ui*
27432743

27442744

27452745
==============================================================================
2746-
Class: config.experimental *nvim-tree-config-experimental*
2746+
Config: experimental *nvim-tree-config-experimental*
27472747

27482748
*nvim_tree.config.experimental*
27492749
Experimental features that may become default or optional functionality.
@@ -2754,7 +2754,7 @@ Class: config.experimental *nvim-tree-config-experimental*
27542754

27552755

27562756
==============================================================================
2757-
Class: config.log *nvim-tree-config-log*
2757+
Config: log *nvim-tree-config-log*
27582758

27592759
*nvim_tree.config.log*
27602760
Log to a file `nvim-tree.log` in |stdpath()| `log`, usually
@@ -2790,7 +2790,7 @@ Class: config.log *nvim-tree-config-log*
27902790

27912791

27922792
==============================================================================
2793-
Config: default *nvim-tree-default-config*
2793+
Config: Default *nvim-tree-default-config*
27942794

27952795
Following is the default configuration, see |nvim_tree.config| for details. >lua
27962796

‎scripts/gen_vimdoc_config.lua‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,30 +12,30 @@
1212
---Help txt is deleted from first tag down and generated content is appended.
1313
---@type Src[]
1414
local srcs = {
15-
{ helptag = "nvim-tree-config", section = "Class: config", path = "./lua/nvim_tree/_meta/config.lua", },
16-
{ helptag = "nvim-tree-config-sort", section = "Class: config.sort", path = "./lua/nvim_tree/_meta/config/sort.lua", },
17-
{ helptag = "nvim-tree-config-view", section = "Class: config.view", path = "./lua/nvim_tree/_meta/config/view.lua", },
18-
{ helptag = "nvim-tree-config-renderer", section = "Class: config.renderer", path = "./lua/nvim_tree/_meta/config/renderer.lua", },
19-
{ helptag = "nvim-tree-config-hijack-directories", section = "Class: config.hijack_directories", path = "./lua/nvim_tree/_meta/config/hijack_directories.lua", },
20-
{ helptag = "nvim-tree-config-update-focused-file", section = "Class: config.update_focused_file", path = "./lua/nvim_tree/_meta/config/update_focused_file.lua", },
21-
{ helptag = "nvim-tree-config-system-open", section = "Class: config.system_open", path = "./lua/nvim_tree/_meta/config/system_open.lua", },
22-
{ helptag = "nvim-tree-config-git", section = "Class: config.git", path = "./lua/nvim_tree/_meta/config/git.lua", },
23-
{ helptag = "nvim-tree-config-diagnostics", section = "Class: config.diagnostics", path = "./lua/nvim_tree/_meta/config/diagnostics.lua", },
24-
{ helptag = "nvim-tree-config-modified", section = "Class: config.modified", path = "./lua/nvim_tree/_meta/config/modified.lua", },
25-
{ helptag = "nvim-tree-config-filters", section = "Class: config.filters", path = "./lua/nvim_tree/_meta/config/filters.lua", },
26-
{ helptag = "nvim-tree-config-live-filter", section = "Class: config.live_filter", path = "./lua/nvim_tree/_meta/config/live_filter.lua", },
27-
{ helptag = "nvim-tree-config-filesystem-watchers", section = "Class: config.filesystem_watchers", path = "./lua/nvim_tree/_meta/config/filesystem_watchers.lua", },
28-
{ helptag = "nvim-tree-config-actions", section = "Class: config.actions", path = "./lua/nvim_tree/_meta/config/actions.lua", },
29-
{ helptag = "nvim-tree-config-trash", section = "Class: config.trash", path = "./lua/nvim_tree/_meta/config/trash.lua", },
30-
{ helptag = "nvim-tree-config-tab", section = "Class: config.tab", path = "./lua/nvim_tree/_meta/config/tab.lua", },
31-
{ helptag = "nvim-tree-config-notify", section = "Class: config.notify", path = "./lua/nvim_tree/_meta/config/notify.lua", },
32-
{ helptag = "nvim-tree-config-bookmarks", section = "Class: config.bookmarks", path = "./lua/nvim_tree/_meta/config/bookmarks.lua", },
33-
{ helptag = "nvim-tree-config-help", section = "Class: config.help", path = "./lua/nvim_tree/_meta/config/help.lua", },
34-
{ helptag = "nvim-tree-config-ui", section = "Class: config.ui", path = "./lua/nvim_tree/_meta/config/ui.lua", name = "UI", },
35-
{ helptag = "nvim-tree-config-experimental", section = "Class: config.experimental", path = "./lua/nvim_tree/_meta/config/experimental.lua", },
36-
{ helptag = "nvim-tree-config-log", section = "Class: config.log", path = "./lua/nvim_tree/_meta/config/log.lua", },
37-
38-
{ helptag = "nvim-tree-default-config", section = "Config: default", path = "./lua/nvim_tree/_meta/config/default.lua", },
15+
{ helptag = "nvim-tree-config", section = "Config", path = "./lua/nvim_tree/_meta/config.lua", },
16+
{ helptag = "nvim-tree-config-sort", section = "Config: sort", path = "./lua/nvim_tree/_meta/config/sort.lua", },
17+
{ helptag = "nvim-tree-config-view", section = "Config: view", path = "./lua/nvim_tree/_meta/config/view.lua", },
18+
{ helptag = "nvim-tree-config-renderer", section = "Config: renderer", path = "./lua/nvim_tree/_meta/config/renderer.lua", },
19+
{ helptag = "nvim-tree-config-hijack-directories", section = "Config: hijack_directories", path = "./lua/nvim_tree/_meta/config/hijack_directories.lua", },
20+
{ helptag = "nvim-tree-config-update-focused-file", section = "Config: update_focused_file", path = "./lua/nvim_tree/_meta/config/update_focused_file.lua", },
21+
{ helptag = "nvim-tree-config-system-open", section = "Config: system_open", path = "./lua/nvim_tree/_meta/config/system_open.lua", },
22+
{ helptag = "nvim-tree-config-git", section = "Config: git", path = "./lua/nvim_tree/_meta/config/git.lua", },
23+
{ helptag = "nvim-tree-config-diagnostics", section = "Config: diagnostics", path = "./lua/nvim_tree/_meta/config/diagnostics.lua", },
24+
{ helptag = "nvim-tree-config-modified", section = "Config: modified", path = "./lua/nvim_tree/_meta/config/modified.lua", },
25+
{ helptag = "nvim-tree-config-filters", section = "Config: filters", path = "./lua/nvim_tree/_meta/config/filters.lua", },
26+
{ helptag = "nvim-tree-config-live-filter", section = "Config: live_filter", path = "./lua/nvim_tree/_meta/config/live_filter.lua", },
27+
{ helptag = "nvim-tree-config-filesystem-watchers", section = "Config: filesystem_watchers", path = "./lua/nvim_tree/_meta/config/filesystem_watchers.lua", },
28+
{ helptag = "nvim-tree-config-actions", section = "Config: actions", path = "./lua/nvim_tree/_meta/config/actions.lua", },
29+
{ helptag = "nvim-tree-config-trash", section = "Config: trash", path = "./lua/nvim_tree/_meta/config/trash.lua", },
30+
{ helptag = "nvim-tree-config-tab", section = "Config: tab", path = "./lua/nvim_tree/_meta/config/tab.lua", },
31+
{ helptag = "nvim-tree-config-notify", section = "Config: notify", path = "./lua/nvim_tree/_meta/config/notify.lua", },
32+
{ helptag = "nvim-tree-config-bookmarks", section = "Config: bookmarks", path = "./lua/nvim_tree/_meta/config/bookmarks.lua", },
33+
{ helptag = "nvim-tree-config-help", section = "Config: help", path = "./lua/nvim_tree/_meta/config/help.lua", },
34+
{ helptag = "nvim-tree-config-ui", section = "Config: ui", path = "./lua/nvim_tree/_meta/config/ui.lua", name = "UI", },
35+
{ helptag = "nvim-tree-config-experimental", section = "Config: experimental", path = "./lua/nvim_tree/_meta/config/experimental.lua", },
36+
{ helptag = "nvim-tree-config-log", section = "Config: log", path = "./lua/nvim_tree/_meta/config/log.lua", },
37+
38+
{ helptag = "nvim-tree-default-config", section = "Config: Default", path = "./lua/nvim_tree/_meta/config/default.lua", },
3939
}
4040

4141
-- hydrate file names

0 commit comments

Comments
 (0)