diff options
| author | Alyssa Ross <hi@alyssa.is> | 2021-05-05 13:56:23 +0000 |
|---|---|---|
| committer | Alyssa Ross <hi@alyssa.is> | 2021-05-05 14:34:46 +0000 |
| commit | 5f07f2ff2b964bec71be34cf6cf1265ce88b7490 (patch) | |
| tree | 7b22af419e30be4c2a54883a838a845d4b22f05b /doc/manual/generate-builtins.nix | |
| parent | fe3a10a9b2c61ba19b24da4c93c4abc9e7583f3d (diff) | |
doc: builtins: use a definition list
This looks a lot better (and is also more semantically meaningful).
Since this list is generated in a Nix expression, I don't think using
HTML here is going to be the thing that puts people off modifying this
part of the documentation!
Diffstat (limited to 'doc/manual/generate-builtins.nix')
| -rw-r--r-- | doc/manual/generate-builtins.nix | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/manual/generate-builtins.nix b/doc/manual/generate-builtins.nix index 416a7fdba..92c7b1a31 100644 --- a/doc/manual/generate-builtins.nix +++ b/doc/manual/generate-builtins.nix @@ -6,9 +6,11 @@ builtins: concatStrings (map (name: let builtin = builtins.${name}; in - " - `builtins.${name}` " + concatStringsSep " " (map (s: "*${s}*") builtin.args) - + " \n\n" - + concatStrings (map (s: " ${s}\n") (splitLines builtin.doc)) + "\n\n" + "<dt><code>${name} " + + concatStringsSep " " (map (s: "<var>${s}</var>") builtin.args) + + "</code></dt>" + + "<dd>\n\n" + + builtin.doc + + "\n\n</dd>" ) (attrNames builtins)) - |