NotAShelf/nvf
2
1
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-12-16 17:11:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

wrapper/rc: add examples to vim.options & vim.globals; wording

Browse source
This commit is contained in:
raf 2024-09-28 21:06:41 +03:00
commit 8b29ba9e23
Signed by: NotAShelf
GPG key ID: AF26552424E53993
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
modules/wrapper/rc/options.nix
View file

@ -129,6 +129,7 @@ in {
globals = mkOption {
type = attrs;
default = {};
example = {"some_variable" = 42;};
description = ''
An attribute set containing global variable values
for storing vim variables as early as possible. If
@ -136,10 +137,10 @@ in {
built luaConfigRC as the first item.
::: {.note}
`{foo = "bar";}` will set `vim.g.foo` to "bar" where
`{foo = "bar";}` will set `vim.g.foo` to "bar", where
the type of `bar` in the resulting Lua value will be
infered from the type of the value in the `{name = value;}`
pair.
inferred from the type of the value in the `{name = value;}`
pair passed to the option.
:::
'';
};
@ -147,6 +148,7 @@ in {
options = mkOption {
type = attrs;
default = {};
example = {visualbell = true;};
description = ''
An attribute set containing vim options to be set
as early as possible. If populated, this option will
@ -154,10 +156,10 @@ in {
and before `pluginConfigs` DAG entries.
::: {.note}
`{foo = "bar"}` will set `vim.o.foo` to "bar" where
`{foo = "bar";}` will set `vim.o.foo` to "bar", where
the type of `bar` in the resulting Lua value will be
infered from the type of the value in the `{name = value}`
pair.
inferred from the type of the value in the`{name = value;}`
pair passed to the option.
:::
'';
};