lib/vim-plugin: fix + improve settings example (#1774)

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

See related issue #1741

(cherry picked from commit b0d8c00264)

Co-authored-by: Matt Sturgeon <matt@sturgeon.me.uk>
This commit is contained in:
mergify[bot] 2024-06-29 01:02:51 +00:00 committed by GitHub
parent 8f52e4d1e3
commit 2bc337ace2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

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`
'';
};
};