From 2bc337ace296a30cd7faf729709c1fee84d90fc7 Mon Sep 17 00:00:00 2001
From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com>
Date: Sat, 29 Jun 2024 01:02:51 +0000
Subject: [PATCH] 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 b0d8c002643119d6c1f7c1c501614ae56a45cc39)

Co-authored-by: Matt Sturgeon <matt@sturgeon.me.uk>
---
 lib/vim-plugin.nix | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/lib/vim-plugin.nix b/lib/vim-plugin.nix
index 3b891213..676be98f 100644
--- a/lib/vim-plugin.nix
+++ b/lib/vim-plugin.nix
@@ -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`
           '';
         };
       };