Use markdown by default

This commit is contained in:
Robert Hensing 2022-11-11 06:40:37 +01:00
parent fb87cc7333
commit 6b87695050
16 changed files with 66 additions and 55 deletions

View file

@ -16,17 +16,21 @@ in
{
options = {
systems = mkOption {
description = "All the system types to enumerate in the flake.";
description = lib.mdDoc ''
All the system types to enumerate in the flake output subattributes.
In other words, all valid values for `system` in e.g. `packages.<system>.foo`.
'';
type = types.listOf types.str;
};
perInput = mkOption {
description = "Function from system to function from flake to <literal>system</literal>-specific attributes.";
description = lib.mdDoc "Function from system to function from flake to `system`-specific attributes.";
type = types.functionTo (types.functionTo (types.lazyAttrsOf types.unspecified));
};
perSystem = mkOption {
description = "A function from system to flake-like attributes omitting the <literal>&lt;system></literal> attribute.";
description = lib.mdDoc "A function from system to flake-like attributes omitting the `<system>` attribute.";
type = mkPerSystemType ({ config, system, ... }: {
_file = ./perSystem.nix;
config = {
@ -46,7 +50,7 @@ in
allSystems = mkOption {
type = types.lazyAttrsOf types.unspecified;
description = "The system-specific config for each of systems.";
description = lib.mdDoc "The system-specific config for each of systems.";
internal = true;
};
};