Skip to content

Commit ffe6b8e

Browse files
committed
docs: remove old opt, rewrite srcery_bg section
srcery_bg needed a better explanation, and bg_passthrough isn't needed or used anymore
1 parent 33545ff commit ffe6b8e

File tree

2 files changed

+23
-34
lines changed

2 files changed

+23
-34
lines changed

README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ slightly earthy tone.
4848
- [g:srcery\_inverse\_matches](#gsrcery_inverse_matches)
4949
- [g:srcery\_inverse\_match\_paren](#gsrcery_inverse_match_paren)
5050
- [g:srcery\_dim\_lisp\_paren](#gsrcery_dim_lisp_paren)
51-
- [g:srcery\_bg\_passthrough](#gsrcery_bg_passthrough)
5251
- [g:srcery\_guisp\_fallback](#gsrcery_guisp_fallback)
5352
- [g:srcery\_italic\_types](#gsrcery_italic_types)
5453
- [g:srcery\_bg](#gsrcery_bg)
@@ -275,18 +274,6 @@ Dims lisp dialects delimiters to a fairly dark gray (xgray5 specifically).
275274

276275
Default: 0
277276

278-
#### g:srcery\_bg\_passthrough
279-
280-
Lets the terminal control the background color in Vim by setting the background to `NONE`.
281-
282-
A possible use case for this could be you want to manipulate the background
283-
color in the terminal, and let the results bubble up to Vim, like [this](https://github.com/roosta/tmux-pop).
284-
285-
This is a bit of an experimental option, and can cause issues in certain
286-
terminals.
287-
288-
Default: 0
289-
290277
#### g:srcery\_guisp\_fallback
291278

292279
Sets up alternate highlighting for colored underline/undercurl. Some
@@ -308,10 +295,17 @@ Default: 0
308295

309296
#### g:srcery\_bg
310297

311-
Background color, specified as an RGB value.
312-
Note that this will only work with 'set termguicolors' in your config, and that it is mutually exclusive with 'g:srcery_hard_black_terminal_bg'.
298+
Default: `[g:srcery_black, 0]`
299+
300+
Let's you customize the background color. This var takes a list with two
301+
elements, with a HEX in the first position, and a terminal color index for the
302+
second position. This lets you set both a 24-bit color, and a 8bit terminal
303+
color index.
304+
305+
You can specify `NONE` as a value, which would be the same as the previous
306+
option `srcery_bg_passthrough`
313307

314-
Default: 'g:srcery_black'
308+
You can specify `DEFAULT` as a value, if you only want to customize one value.
315309

316310
#### g:srcery\_hard\_black\_terminal\_bg
317311

doc/srcery.txt

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ Options |srcery-options|
2525
g:srcery_inverse_matche |srcery-option-inverse-matches|
2626
g:srcery_inverse_match_paren |srcery-option-inverse-match-paren|
2727
g:srcery_dim_lisp_paren |srcery-option-dim-lisp-paren|
28-
g:srcery_bg_passthrough |srcery-option-bg-passthrough|
2928
g:srcery_guisp_fallback |srcery-option-guisp-fallback|
3029
g:srcery_italic_types |srcery-option-italic-types|
3130
g:srcery_bg |srcery-option-bg|
@@ -210,18 +209,6 @@ g:srcery_dim_lisp_paren
210209
Dims lisp dialects delimiters to a fairly dark gray (xgray5
211210
specifically).
212211

213-
Default: 0
214-
215-
*srcery-option-bg-passthrough*
216-
g:srcery_bg_passthrough
217-
218-
Lets the terminal control the background color in Vim by setting the
219-
background NONE.
220-
221-
A possible use case for this could be you want to manipulate the
222-
background color in the terminal, and let the results bubble up to
223-
Vim.
224-
225212
Default: 0
226213

227214
*srcery-option-guisp-fallback*
@@ -246,13 +233,21 @@ g:srcery_italic_types
246233

247234
Default: 0
248235

249-
*srcery-bg*
236+
*srcery-option-bg*
250237
g:srcery_bg
251-
Background color, specified as an RGB value.
252-
Note that this will only work with `set termguicolors` in your config,
253-
and that it is mutually exclusive with `g:srcery_hard_black_terminal_bg`.
254238

255-
Default: `g:srcery_black`
239+
Let's you customize the background color. This var takes a list with
240+
two elements, with a HEX in the first position, and a terminal color
241+
index for the second position. This lets you set both a 24-bit color,
242+
and a 8bit terminal color index.
243+
244+
You can specify `NONE` as a value, which would be the same as the
245+
previous option `srcery_bg_passthrough`
246+
247+
You can specify `DEFAULT` as a value, if you only want to customize
248+
one value.
249+
250+
Default: `[g:srcery_black, 0]`
256251

257252
*srcery-option-hard-black-terminal-bg*
258253
g:srcery_hard_black_terminal_bg

0 commit comments

Comments
 (0)