1
0
Fork 0
mirror of https://github.com/NixOS/nix synced 2025-06-24 18:01:16 +02:00

doc rendering: add functions to scope explicitly (#7378)

* doc rendering: add functions to scope explicitly

this especially helps beginners with code readability, since the origin
of names is always immediately visible.
This commit is contained in:
Valentin Gagarin 2023-05-03 09:16:29 +02:00 committed by GitHub
parent 1540ab7628
commit 5d78dc4176
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 13 deletions

View file

@ -1,8 +1,12 @@
builtinsDump:
let
inherit (builtins) concatStringsSep attrNames;
in
builtinsInfo:
let
showBuiltin = name:
let
inherit (builtinsDump.${name}) doc args;
inherit (builtinsInfo.${name}) doc args;
in
''
<dt id="builtins-${name}">
@ -14,7 +18,7 @@ let
</dd>
'';
listArgs = args: builtins.concatStringsSep " " (map (s: "<var>${s}</var>") args);
listArgs = args: concatStringsSep " " (map (s: "<var>${s}</var>") args);
in
with builtins; concatStringsSep "\n" (map showBuiltin (attrNames builtinsDump))
concatStringsSep "\n" (map showBuiltin (attrNames builtinsInfo))