Skip to content

Commit 43fab32

Browse files
alex-courtisalex-courtis
committed
docs(#3088): tidy section names
1 parent 0c78c27 commit 43fab32

3 files changed

Lines changed: 25 additions & 25 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ This will:
139139
2. Regenerate from `*nvim-tree-config*` to the end of the file, see `gen_vimdoc.sh`
140140
3. Update default mappings in `*nvim-tree-mappings-default*` and `*nvim-tree-quickstart-help*`
141141

142-
Commit your changes then run:
142+
Commit or stage your changes then run:
143143
```sh
144144
make help-check
145145
```

‎doc/nvim-tree-lua.txt‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2052,7 +2052,7 @@ Config: log *nvim-tree-config-log*
20522052

20532053

20542054
==============================================================================
2055-
Config: Default *nvim-tree-default-config*
2055+
Config: Default *nvim-tree-config-default*
20562056

20572057
Following is the default configuration, see |nvim_tree.config| for details. >lua
20582058

@@ -2344,7 +2344,7 @@ Following is the default configuration, see |nvim_tree.config| for details. >lua
23442344

23452345

23462346
==============================================================================
2347-
api Overview *nvim-tree-api*
2347+
API *nvim-tree-api*
23482348

23492349
nvim-tree exposes a public API. This is non breaking, with additions made as
23502350
necessary.
@@ -2383,7 +2383,7 @@ following are functionally identical: >lua
23832383

23842384

23852385
==============================================================================
2386-
api.commands *nvim-tree-api-commands*
2386+
API: commands *nvim-tree-api-commands*
23872387

23882388
get() *nvim_tree.api.commands.get()*
23892389
Retrieve all |nvim-tree-commands|
@@ -2401,7 +2401,7 @@ get() *nvim_tree.api.commands.get()*
24012401

24022402

24032403
==============================================================================
2404-
api.events *nvim-tree-api-events*
2404+
API: events *nvim-tree-api-events*
24052405

24062406
subscribe({event_type}, {callback}) *nvim_tree.api.events.subscribe()*
24072407
Register a handler for an event, see |nvim-tree-events|.
@@ -2412,7 +2412,7 @@ subscribe({event_type}, {callback}) *nvim_tree.api.events.subscribe()*
24122412

24132413

24142414
==============================================================================
2415-
api.filter *nvim-tree-api-filter*
2415+
API: filter *nvim-tree-api-filter*
24162416

24172417
live_filter.clear() *nvim_tree.api.filter.live_filter.clear()*
24182418
Exit live filter mode.
@@ -2423,7 +2423,7 @@ live_filter.start() *nvim_tree.api.filter.live_filter.start()*
24232423

24242424

24252425
==============================================================================
2426-
api.fs *nvim-tree-api-fs*
2426+
API: fs *nvim-tree-api-fs*
24272427

24282428
clear_clipboard() *nvim_tree.api.fs.clear_clipboard()*
24292429
Clear the nvim-tree clipboard.
@@ -2531,7 +2531,7 @@ trash({node}) *nvim_tree.api.fs.trash()*
25312531

25322532

25332533
==============================================================================
2534-
api.health *nvim-tree-api-health*
2534+
API: health *nvim-tree-api-health*
25352535

25362536
hi_test() *nvim_tree.api.health.hi_test()*
25372537
Open a new buffer displaying all nvim-tree highlight groups, their link
@@ -2541,7 +2541,7 @@ hi_test() *nvim_tree.api.health.hi_test()*
25412541

25422542

25432543
==============================================================================
2544-
api.map *nvim-tree-api-map*
2544+
API: map *nvim-tree-api-map*
25452545

25462546
default_on_attach({bufnr}) *nvim_tree.api.map.default_on_attach()*
25472547
Apply all |nvim-tree-mappings-default|. Call from your |nvim_tree.config|
@@ -2567,7 +2567,7 @@ get_keymap_default() *nvim_tree.api.map.get_keymap_default()*
25672567

25682568

25692569
==============================================================================
2570-
api.marks *nvim-tree-api-marks*
2570+
API: marks *nvim-tree-api-marks*
25712571

25722572
bulk.delete() *nvim_tree.api.marks.bulk.delete()*
25732573
Delete all marked, prompting if |nvim_tree.config.ui.confirm| {remove}
@@ -2611,7 +2611,7 @@ toggle({node}) *nvim_tree.api.marks.toggle()*
26112611

26122612

26132613
==============================================================================
2614-
api.node *nvim-tree-api-node*
2614+
API: node *nvim-tree-api-node*
26152615

26162616
buffer.delete({node}, {opts}) *nvim_tree.api.node.buffer.delete()*
26172617
Deletes node's related buffer, if one exists. Executes |:bdelete| or
@@ -2943,7 +2943,7 @@ show_info_popup({node}) *nvim_tree.api.node.show_info_popup()*
29432943

29442944

29452945
==============================================================================
2946-
api.tree *nvim-tree-api-tree*
2946+
API: tree *nvim-tree-api-tree*
29472947

29482948
change_root({path}) *nvim_tree.api.tree.change_root()*
29492949
Change the tree's root to a path.
@@ -3150,7 +3150,7 @@ winid({opts}) *nvim_tree.api.tree.winid()*
31503150

31513151

31523152
==============================================================================
3153-
api Classes *nvim-tree-api-classes*
3153+
API: Classes *nvim-tree-api-classes*
31543154

31553155
Classes shared by multiple API modules.
31563156

‎scripts/gen_vimdoc_config.lua‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,21 @@ local srcs = {
3535
{ helptag = "nvim-tree-config-experimental", section = "Config: experimental", path = "./lua/nvim_tree/_meta/config/experimental.lua", },
3636
{ helptag = "nvim-tree-config-log", section = "Config: log", path = "./lua/nvim_tree/_meta/config/log.lua", },
3737

38-
{ helptag = "nvim-tree-default-config", section = "Config: Default", path = "./lua/nvim_tree/_meta/config/default.lua", },
38+
{ helptag = "nvim-tree-config-default", section = "Config: Default", path = "./lua/nvim_tree/_meta/config/default.lua", },
3939

40-
{ helptag = "nvim-tree-api", section = "api Overview", path = "./lua/nvim_tree/api.lua", },
40+
{ helptag = "nvim-tree-api", section = "API", path = "./lua/nvim_tree/api.lua", },
4141

42-
{ helptag = "nvim-tree-api-commands", section = "api.commands", path = "./lua/nvim_tree/_meta/api/commands.lua", },
43-
{ helptag = "nvim-tree-api-events", section = "api.events", path = "./lua/nvim_tree/_meta/api/events.lua", },
44-
{ helptag = "nvim-tree-api-filter", section = "api.filter", path = "./lua/nvim_tree/_meta/api/filter.lua", },
45-
{ helptag = "nvim-tree-api-fs", section = "api.fs", path = "./lua/nvim_tree/_meta/api/fs.lua", },
46-
{ helptag = "nvim-tree-api-health", section = "api.health", path = "./lua/nvim_tree/_meta/api/health.lua", },
47-
{ helptag = "nvim-tree-api-map", section = "api.map", path = "./lua/nvim_tree/_meta/api/map.lua", },
48-
{ helptag = "nvim-tree-api-marks", section = "api.marks", path = "./lua/nvim_tree/_meta/api/marks.lua", },
49-
{ helptag = "nvim-tree-api-node", section = "api.node", path = "./lua/nvim_tree/_meta/api/node.lua", },
50-
{ helptag = "nvim-tree-api-tree", section = "api.tree", path = "./lua/nvim_tree/_meta/api/tree.lua", },
42+
{ helptag = "nvim-tree-api-commands", section = "API: commands", path = "./lua/nvim_tree/_meta/api/commands.lua", },
43+
{ helptag = "nvim-tree-api-events", section = "API: events", path = "./lua/nvim_tree/_meta/api/events.lua", },
44+
{ helptag = "nvim-tree-api-filter", section = "API: filter", path = "./lua/nvim_tree/_meta/api/filter.lua", },
45+
{ helptag = "nvim-tree-api-fs", section = "API: fs", path = "./lua/nvim_tree/_meta/api/fs.lua", },
46+
{ helptag = "nvim-tree-api-health", section = "API: health", path = "./lua/nvim_tree/_meta/api/health.lua", },
47+
{ helptag = "nvim-tree-api-map", section = "API: map", path = "./lua/nvim_tree/_meta/api/map.lua", },
48+
{ helptag = "nvim-tree-api-marks", section = "API: marks", path = "./lua/nvim_tree/_meta/api/marks.lua", },
49+
{ helptag = "nvim-tree-api-node", section = "API: node", path = "./lua/nvim_tree/_meta/api/node.lua", },
50+
{ helptag = "nvim-tree-api-tree", section = "API: tree", path = "./lua/nvim_tree/_meta/api/tree.lua", },
5151

52-
{ helptag = "nvim-tree-api-classes", section = "api Classes", path = "./lua/nvim_tree/_meta/api/classes.lua", },
52+
{ helptag = "nvim-tree-api-classes", section = "API: Classes", path = "./lua/nvim_tree/_meta/api/classes.lua", },
5353
}
5454

5555
-- hydrate file names

0 commit comments

Comments
 (0)