Add a quick explanation blurb to importNickel

nickel-lang · Jun 21, 2024 · a2042c5 · a2042c5
1 parent 2594ced
commit a2042c5
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lib/lib.nix b/lib/lib.nix
@@ -157,6 +157,11 @@
 
   /*
   Import a Nickel expression as a Nix value.
+
+  The result of the Nickel evaluation will be directly mapped to Nix values
+  (through their JSON interface), with the exception of record containing the
+  special `__organist_type` field which have a special treatment as per the
+  `importFromNickel` function above.
   */
   importNickel = {
     /*