lib/vim-plugin: fix + improve settings example

`foo_bar = true` -> `${prefix}foo_bar=1` is incorrect and confusing.

See related issue #1741
This commit is contained in:
Matt Sturgeon 2024-06-25 18:36:59 +01:00
parent 039f6c1973
commit b0d8c00264
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299

View file

@ -54,12 +54,11 @@ with lib;
description = ''
The configuration options for **${name}** without the `${globalPrefix}` prefix.
Example: To set `${globalPrefix}foo_bar` to `1`, write
```nix
settings = {
foo_bar = true;
};
```
For example, the following settings are equivialent to these `:setglobal` commands:
- `foo_bar = 1` -> `:setglobal ${globalPrefix}foo_bar=1`
- `hello = "world"` -> `:setglobal ${globalPrefix}hello="world"`
- `some_toggle = true` -> `:setglobal ${globalPrefix}some_toggle`
- `other_toggle = false` -> `:setglobal no${globalPrefix}other_toggle`
'';
};
};