From 82415eaa5d0f3e71e7fcbc0b4038aef1220737f0 Mon Sep 17 00:00:00 2001
From: Matt Sturgeon <matt@sturgeon.me.uk>
Date: Sun, 19 Jan 2025 13:10:34 +0000
Subject: [PATCH] modules/nixpkgs: warn about changing defaults

If end-users change the nixpkgs revision to something other than our
default, they can run into issues not picked up by our test suite.
---
 modules/top-level/nixpkgs.nix | 8 +++++---
 wrappers/modules/nixpkgs.nix  | 3 +++
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/modules/top-level/nixpkgs.nix b/modules/top-level/nixpkgs.nix
index 61366d76..24e9380b 100644
--- a/modules/top-level/nixpkgs.nix
+++ b/modules/top-level/nixpkgs.nix
@@ -50,9 +50,8 @@ in
         so user-provided configuration can override it without using `lib`.
         E.g. Nixvim's home-manager module can re-use the `pkgs` instance from the "host" modules.
 
-        > [!NOTE]
-        > Using a distinct version of Nixpkgs with Nixvim may be an unexpected source of problems.
-        > Use this option with care.
+        > [!CAUTION]
+        > Changing this option can lead to issues that may be difficult to debug.
       '';
     };
 
@@ -198,6 +197,9 @@ in
         The path to import Nixpkgs from.
 
         Ignored when `nixpkgs.pkgs` is set.
+
+        > [!CAUTION]
+        > Changing this option can lead to issues that may be difficult to debug.
       '';
     };
   };
diff --git a/wrappers/modules/nixpkgs.nix b/wrappers/modules/nixpkgs.nix
index 8d0459e9..f8b6dc5e 100644
--- a/wrappers/modules/nixpkgs.nix
+++ b/wrappers/modules/nixpkgs.nix
@@ -40,6 +40,9 @@ in
       description = ''
         Whether Nixvim should use the ${config.meta.wrapper.name} configuration's `pkgs`,
         instead of constructing its own instance.
+
+        > [!CAUTION]
+        > Changing this option can lead to issues that may be difficult to debug.
       '';
     };
   };