Skip to content

Commit d685ddf

Browse files
authored
Merge pull request #18 from aiya000/feature/tmp-file-pattern-when-tmp-buffer-and-when-file-buffer
Support g:scratch_buffer_file_pattern dictionary
2 parents c7a46c1 + e863712 commit d685ddf

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

doc/vim-scratch-buffer.txt

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,10 @@ INTERFACE *scratch-buffer-interface*
7272
VARIABLES *scratch-buffer-variables*
7373

7474
*g:scratch_buffer_file_pattern*
75-
Type: `{ when_tmp_buffer?: string, when_file_buffer?: string }`
75+
Type (Vim): `{ when_tmp_buffer?: string, when_file_buffer?: string }`
76+
77+
(The type is different if you are using Neovim.
78+
Please see below 'NOTICE for Neovim:' section.)
7679

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

126+
NOTICE for Neovim:
127+
You must set this properties exactly if you are using Neovim.
128+
Meaning:
129+
- Type (Neovim): `{ when_tmp_buffer: string, when_file_buffer: string }`
130+
This is a limitation of Neovim's Vim script compatibility.
131+
123132
*g:scratch_buffer_default_file_ext*
124133
Type: `string`
125134
Default: `'md'`

0 commit comments

Comments
 (0)