lix/doc/manual/generate-builtins.nix

let
  inherit (builtins) concatStringsSep attrNames;
in

builtinsInfo:
let
  showBuiltin = name:
    let
      inherit (builtinsInfo.${name}) doc args;
    in
    ''
      <dt id="builtins-${name}">
        <a href="#builtins-${name}"><code>${name} ${listArgs args}</code></a>
      </dt>
      <dd>

        ${doc}

      </dd>
    '';
  listArgs = args: concatStringsSep " " (map (s: "<var>${s}</var>") args);
in
concatStringsSep "\n" (map showBuiltin (attrNames builtinsInfo))
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. 2023-05-03 07:16:29 +00:00			`let`
			`inherit (builtins) concatStringsSep attrNames;`
			`in`

			`builtinsInfo:`
refactor rendering documentation of builtins as in [1], make the document structure visible, like in a template [1]: 4655563470b59e0ef50a33af003058c2b54db778 2022-11-24 12:47:08 +00:00			`let`
			`showBuiltin = name:`
			`let`
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. 2023-05-03 07:16:29 +00:00			`inherit (builtinsInfo.${name}) doc args;`
refactor rendering documentation of builtins as in [1], make the document structure visible, like in a template [1]: 4655563470b59e0ef50a33af003058c2b54db778 2022-11-24 12:47:08 +00:00			`in`
			`''`
			`<dt id="builtins-${name}">`
			`<a href="#builtins-${name}"><code>${name} ${listArgs args}</code></a>`
			`</dt>`
			`<dd>`
jq -> nix 2020-09-16 12:55:24 +00:00
refactor rendering documentation of builtins as in [1], make the document structure visible, like in a template [1]: 4655563470b59e0ef50a33af003058c2b54db778 2022-11-24 12:47:08 +00:00			`${doc}`

			`</dd>`
			`'';`
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. 2023-05-03 07:16:29 +00:00			`listArgs = args: concatStringsSep " " (map (s: "<var>${s}</var>") args);`
refactor rendering documentation of builtins as in [1], make the document structure visible, like in a template [1]: 4655563470b59e0ef50a33af003058c2b54db778 2022-11-24 12:47:08 +00:00			`in`
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. 2023-05-03 07:16:29 +00:00			`concatStringsSep "\n" (map showBuiltin (attrNames builtinsInfo))`
jq -> nix 2020-09-16 12:55:24 +00:00