Skip to content

Commit 509962f

Browse files
authored
docs: update to 0.12 help format, remove blank line help suppression (#3314)
doc: update to 0.12 help format, remove blank line help suppression
1 parent 85d1145 commit 509962f

File tree

2 files changed

+1
-50
lines changed

2 files changed

+1
-50
lines changed

Makefile

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,10 @@ help-update:
4343

4444
#
4545
# CI
46-
# --ignore-blank-lines is used as nightly has removed unnecessary blank lines that stable (0.11.5) currently inserts
4746
#
4847
help-check: help-update
4948
scripts/vimdoc.sh lintdoc
50-
git diff --ignore-blank-lines --exit-code doc/nvim-tree-lua.txt
49+
git diff --exit-code doc/nvim-tree-lua.txt
5150

5251

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

doc/nvim-tree-lua.txt

Lines changed: 0 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1075,8 +1075,6 @@ Config *nvim-tree-config*
10751075
{log}? (`nvim_tree.config.log`)
10761076
|nvim_tree.config.log|
10771077

1078-
1079-
10801078
==============================================================================
10811079
Config: sort *nvim-tree-config-sort*
10821080

@@ -1115,8 +1113,6 @@ Config: sort *nvim-tree-config-sort*
11151113
folders. Has no effect when {sorter} is a function.
11161114
Overrides {folders_first}.
11171115

1118-
1119-
11201116
==============================================================================
11211117
Config: view *nvim-tree-config-view*
11221118

@@ -1201,8 +1197,6 @@ Config: view *nvim-tree-config-view*
12011197
{padding}? (`nvim_tree.config.view.width.spec`, default: `1`)
12021198
Extra padding to the right.
12031199

1204-
1205-
12061200
==============================================================================
12071201
Config: renderer *nvim-tree-config-renderer*
12081202

@@ -1447,8 +1441,6 @@ Config: renderer *nvim-tree-config-renderer*
14471441
{bottom}? (`string`) (default: `""`)
14481442
{none}? (`string`) (default: `" "`)
14491443

1450-
1451-
14521444
==============================================================================
14531445
Config: hijack_directories *nvim-tree-config-hijack-directories*
14541446

@@ -1465,8 +1457,6 @@ Config: hijack_directories *nvim-tree-config-hijack-directories*
14651457
• {auto_open}? (`boolean`, default: `true`) Open if the tree was
14661458
previously closed.
14671459

1468-
1469-
14701460
==============================================================================
14711461
Config: update_focused_file *nvim-tree-config-update-focused-file*
14721462

@@ -1497,8 +1487,6 @@ Config: update_focused_file *nvim-tree-config-update-focused-file*
14971487
tree if the file isn't found under the current root
14981488
directory.
14991489

1500-
1501-
15021490
==============================================================================
15031491
Config: git *nvim-tree-config-git*
15041492

@@ -1531,8 +1519,6 @@ Config: git *nvim-tree-config-git*
15311519
• {cygwin_support}? (`boolean`, default: `false`) Use `cygpath` if
15321520
available to resolve paths for git.
15331521

1534-
1535-
15361522
==============================================================================
15371523
Config: diagnostics *nvim-tree-config-diagnostics*
15381524

@@ -1565,8 +1551,6 @@ Config: diagnostics *nvim-tree-config-diagnostics*
15651551
{warning}? (`string`) (default: `""` )
15661552
{error}? (`string`) (default: `""` )
15671553

1568-
1569-
15701554
==============================================================================
15711555
Config: modified *nvim-tree-config-modified*
15721556

@@ -1587,8 +1571,6 @@ Config: modified *nvim-tree-config-modified*
15871571
indication on open directories. Requires
15881572
{show_on_dirs}.
15891573

1590-
1591-
15921574
==============================================================================
15931575
Config: filters *nvim-tree-config-filters*
15941576

@@ -1642,8 +1624,6 @@ Config: filters *nvim-tree-config-filters*
16421624
(default: `{}`)
16431625
{exclude}? (`string[]`) (default: `{}`)
16441626

1645-
1646-
16471627
==============================================================================
16481628
Config: live_filter *nvim-tree-config-live-filter*
16491629

@@ -1660,8 +1640,6 @@ Config: live_filter *nvim-tree-config-live-filter*
16601640
• {always_show_folders}? (`boolean`, default: `true`) Whether to filter
16611641
folders or not.
16621642

1663-
1664-
16651643
==============================================================================
16661644
Config: filesystem_watchers *nvim-tree-config-filesystem-watchers*
16671645

@@ -1708,8 +1686,6 @@ Config: filesystem_watchers *nvim-tree-config-filesystem-watchers*
17081686
{debounce_delay}. Set to 0 to allow unlimited
17091687
consecutive events.
17101688

1711-
1712-
17131689
==============================================================================
17141690
Config: actions *nvim-tree-config-actions*
17151691

@@ -1831,8 +1807,6 @@ Config: actions *nvim-tree-config-actions*
18311807
displays a file when removing that file from the
18321808
tree.
18331809

1834-
1835-
18361810
==============================================================================
18371811
Config: trash *nvim-tree-config-trash*
18381812

@@ -1846,8 +1820,6 @@ Config: trash *nvim-tree-config-trash*
18461820
Fields: ~
18471821
{cmd}? (`string`) (default: `"gio trash"` or `"trash"`)
18481822

1849-
1850-
18511823
==============================================================================
18521824
Config: tab *nvim-tree-config-tab*
18531825

@@ -1867,8 +1839,6 @@ Config: tab *nvim-tree-config-tab*
18671839
{ignore}? (`string[]`, default: `{}`) List of filetypes or buffer
18681840
names on new tab that will prevent `open` and `close`
18691841

1870-
1871-
18721842
==============================================================================
18731843
Config: notify *nvim-tree-config-notify*
18741844

@@ -1886,8 +1856,6 @@ Config: notify *nvim-tree-config-notify*
18861856
• {absolute_path}? (`boolean`, default: `true`) Use absolute paths in
18871857
FS action notifications, otherwise item names.
18881858

1889-
1890-
18911859
==============================================================================
18921860
Config: bookmarks *nvim-tree-config-bookmarks*
18931861

@@ -1900,8 +1868,6 @@ Config: bookmarks *nvim-tree-config-bookmarks*
19001868
Fields: ~
19011869
{persist}? (`boolean|string`) (default: `false`)
19021870

1903-
1904-
19051871
==============================================================================
19061872
Config: help *nvim-tree-config-help*
19071873

@@ -1915,8 +1881,6 @@ Config: help *nvim-tree-config-help*
19151881
Fields: ~
19161882
• {sort_by}? (`nvim_tree.config.help.sort_by`) (default: `"key"`)
19171883

1918-
1919-
19201884
==============================================================================
19211885
Config: ui *nvim-tree-config-ui*
19221886

@@ -1935,8 +1899,6 @@ Config: ui *nvim-tree-config-ui*
19351899
• {default_yes}? (`boolean`, default: `false`) If `true` the prompt
19361900
will be `Y/n`, otherwise `y/N`
19371901

1938-
1939-
19401902
==============================================================================
19411903
Config: experimental *nvim-tree-config-experimental*
19421904

@@ -1946,8 +1908,6 @@ Config: experimental *nvim-tree-config-experimental*
19461908
In the event of a problem please disable the experiment and raise an
19471909
issue.
19481910

1949-
1950-
19511911
==============================================================================
19521912
Config: log *nvim-tree-config-log*
19531913

@@ -1982,8 +1942,6 @@ Config: log *nvim-tree-config-log*
19821942
|nvim_tree.config.filesystem_watchers| processing,
19831943
verbose.
19841944

1985-
1986-
19871945
==============================================================================
19881946
Config: Default *nvim-tree-config-default*
19891947

@@ -2273,8 +2231,6 @@ Following is the default configuration, see |nvim_tree.config| for details. >lua
22732231
}
22742232
<
22752233

2276-
2277-
22782234
==============================================================================
22792235
API *nvim-tree-api*
22802236

@@ -2354,8 +2310,6 @@ e.g. the following are functionally identical: >lua
23542310
{dir}? (`table<"direct"|"indirect", nvim_tree.git.XY[]>`) direct
23552311
inclusive-or indirect status
23562312

2357-
2358-
23592313
==============================================================================
23602314
API: appearance *nvim-tree-api-appearance*
23612315

@@ -3466,6 +3420,4 @@ Contents of `my-decorator.lua`: >lua
34663420
return MyDecorator
34673421
<
34683422

3469-
3470-
34713423
vim:tw=78:ts=8:sw=4:sts=4:et:ft=help:norl:

0 commit comments

Comments
 (0)