Skip to content

Commit

Permalink
Add a quick explanation blurb to importNickel
Browse files Browse the repository at this point in the history
  • Loading branch information
Théophane Hufschmitt committed Jun 19, 2024
1 parent a7af8ed commit 2d0100f
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion lib/lib.nix
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
/*
Expand All @@ -181,7 +186,7 @@
nixpkgs = pkgs;
organist = import organistSrc;
},
}: let
} /* -> Any */ : let
nickelResult = callNickel {inherit nickelArgs baseDir;};
in
{rawNickel = nickelResult;}
Expand Down

0 comments on commit 2d0100f

Please sign in to comment.