Skip to content

Commit 25b2da8

Browse files
committed
Use '+' instead of '-' for (nested) lists.
This allows "<" to be concealed in the documentation (specifically the documentation for working around scrollbar floating windows being included in the window count returned by winnr('$')). See the following pages for more details on the issue. - neovim/tree-sitter-vimdoc#146 - neovim/tree-sitter-vimdoc#118
1 parent 61493e7 commit 25b2da8

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

doc/scrollview.txt

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -967,29 +967,29 @@ register_sign_spec({spec}) *scrollview.register_sign_spec()*
967967

968968
Parameters: ~
969969
* {spec} (table) Keyword arguments |kwargs|:
970-
- current_only (boolean): Show only in an current window (the
970+
+ current_only (boolean): Show only in an current window (the
971971
window with the cursor at the time of display). Defaults to
972972
`false`.
973-
- extend (boolean): Show each sign on all corresponding rows
973+
+ extend (boolean): Show each sign on all corresponding rows
974974
of the scrollview column, instead of just a single row. This
975975
is relevant when |scrollview_always_show| is on and all lines
976976
and at least one filler line are visible.
977-
- group (string): Defaults to `'other'`.
978-
- highlight (string): Defaults to `'Pmenu'`.
979-
- priority (integer): Defaults to `50`.
980-
- show_in_folds (boolean|nil): Include signs for lines in
977+
+ group (string): Defaults to `'other'`.
978+
+ highlight (string): Defaults to `'Pmenu'`.
979+
+ priority (integer): Defaults to `50`.
980+
+ show_in_folds (boolean|nil): Include signs for lines in
981981
closed folds. When non-`nil`, overrides the value of
982982
|scrollview_signs_show_in_folds|. Defaults to `nil`.
983-
- symbol (string): Defaults to `''`.
984-
- type (string): `'b'` for buffer-local signs, `'w'` for
983+
+ symbol (string): Defaults to `''`.
984+
+ type (string): `'b'` for buffer-local signs, `'w'` for
985985
window-local signs. Defaults to `'b'`.
986-
- variant (string|nil): Used for groups that include multiple
986+
+ variant (string|nil): Used for groups that include multiple
987987
variants. Defaults to `nil`.
988988

989989
Return: ~
990990
(table) a table with the following key-value pairs.
991-
- id (integer): A unique identifier.
992-
- name (string): Variable name that should be used for saving
991+
+ id (integer): A unique identifier.
992+
+ name (string): Variable name that should be used for saving
993993
a list-like table with line numbers corresponding to signs.
994994
The variable should be saved to the buffer if the
995995
registration specified type `'b'`, or to the window if the
@@ -1131,13 +1131,13 @@ Error Message Issues ~
11311131
E5601: Cannot close window, only floating window would remain
11321132
< Neovim Issue #11440 is the corresponding issue, opened November 23, 2019
11331133
and closed February 11, 2022.
1134-
- Workaround 1: Use |:quit|, |ZZ|, |ZQ|, or another command that quits the
1134+
+ Workaround 1: Use |:quit|, |ZZ|, |ZQ|, or another command that quits the
11351135
current window (as opposed to a window-closing command).
1136-
- Workaround 2: Use |:only| or `<ctrl-w>o` on the last window of the tab,
1136+
+ Workaround 2: Use |:only| or `<ctrl-w>o` on the last window of the tab,
11371137
which has the side-effect of closing all floating windows (including
11381138
scrollbars). A subsequent window-closing command works without error.
1139-
- Workaround 3: Use |:tabclose|.
1140-
- Workaround 4: Remap the problematic key sequence accordingly. >
1139+
+ Workaround 3: Use |:tabclose|.
1140+
+ Workaround 4: Remap the problematic key sequence accordingly. >
11411141
nnoremap <silent> <c-w>c
11421142
\ <cmd>silent! ScrollViewDisable<cr>
11431143
\<cmd>execute "normal! \<c-w>c"<cr>
@@ -1154,10 +1154,10 @@ Error Message Issues ~
11541154
E444: Cannot close last window
11551155
< The buffer may not be deleted from the buffer list. Neovim Issue #13628 is
11561156
the corresponding issue, opened December 28, 2020 and closed March 23, 2022.
1157-
- Workaround 1: Use |:only| or `<ctrl-w>o`, which has the side-effect of closing
1157+
+ Workaround 1: Use |:only| or `<ctrl-w>o`, which has the side-effect of closing
11581158
all floating windows (including scrollbars). A subsequent |:bdelete| command
11591159
works without error.
1160-
- Workaround 2: Create a `Bdelete` command that avoids the issue. >
1160+
+ Workaround 2: Create a `Bdelete` command that avoids the issue. >
11611161
command Bdelete
11621162
\ silent! ScrollViewDisable
11631163
\ | bdelete
@@ -1168,15 +1168,15 @@ Other Issues ~
11681168
* For `nvim<=0.7.0`, sessions cannot be properly restored by |:mksession| scripts
11691169
created when the plugin is active (Issue #71). Neovim Issue #18432 is the
11701170
corresponding issue, opened May 5, 2022.
1171-
- Workaround: Create a `MkSession` command that avoids the problem. >
1171+
+ Workaround: Create a `MkSession` command that avoids the problem. >
11721172
command -bang -nargs=? MkSession
11731173
\ silent! ScrollViewDisable
11741174
\ | mksession<bang> <args>
11751175
\ | silent! ScrollViewEnable
11761176
11771177
* Because scrollbars are floating windows, they are included in the window
11781178
count returned by `winnr('$')`.
1179-
- Workaround 1: Use a Vimscript function that omits external and floating
1179+
+ Workaround 1: Use a Vimscript function that omits external and floating
11801180
windows in the count. >
11811181
function! WindowCount()
11821182
let l:result = 0
@@ -1189,7 +1189,7 @@ Other Issues ~
11891189
endfor
11901190
return l:result
11911191
endfunction
1192-
< - Workaround 2: Use a Lua function that omits external and floating windows
1192+
< + Workaround 2: Use a Lua function that omits external and floating windows
11931193
in the count. >
11941194
local window_count = function()
11951195
local result = 0

0 commit comments

Comments
 (0)