lib/types: add doc warning to addCheck (#412364)

2025-06-02 18:39:27 +02:00
parent ac5a33bdab 7063762d13
commit f54b76bc01
1 changed files with 7 additions and 1 deletions
@@ -1455,8 +1455,14 @@ let
          nestedTypes.coercedType = coercedType;
          nestedTypes.finalType = finalType;
        };
+      /**
+        Augment the given type with an additional type check function.

-      # Augment the given type with an additional type check function.
+        :::{.warning}
+        This function has some broken behavior see: [#396021](https://github.com/NixOS/nixpkgs/issues/396021)
+        Fixing is not trivial, we appreciate any help!
+        :::
+      */
      addCheck = elemType: check: elemType // { check = x: elemType.check x && check x; };

    };