Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion doc/vim-scratch-buffer.txt
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,10 @@ INTERFACE *scratch-buffer-interface*
VARIABLES *scratch-buffer-variables*

*g:scratch_buffer_file_pattern*
Type: `{ when_tmp_buffer?: string, when_file_buffer?: string }`
Type (Vim): `{ when_tmp_buffer?: string, when_file_buffer?: string }`

(The type is different if you are using Neovim.
Please see below 'NOTICE for Neovim:' section.)

A dictionary specifying file patterns for different buffer types.
Has two keys:
Expand Down Expand Up @@ -120,6 +123,12 @@ VARIABLES *scratch-buffer-variables*
The latter buffer type will overwrite the former as well if the order
is reversed.

NOTICE for Neovim:
You must set this properties exactly if you are using Neovim.
Meaning:
- Type (Neovim): `{ when_tmp_buffer: string, when_file_buffer: string }`
This is a limitation of Neovim's Vim script compatibility.

*g:scratch_buffer_default_file_ext*
Type: `string`
Default: `'md'`
Expand Down