docs(nix): clarify completed Nix prose

This commit was merged in pull request #113.
This commit is contained in:
2026-09-29 22:59:14 -04:00
parent 54335ead82
commit becbb50491
3 changed files with 26 additions and 24 deletions

View File

@@ -35,7 +35,8 @@ in
type = lib.types.attrsOf (lib.types.attrsOf registry.type);
default = { };
description = ''
Lazily collected fleet-visible registry entries, nested by host and entry name.
Stores registry entries that the collector exposes to the fleet.
Nests entries by host and entry name.
'';
}
) definitions;

View File

@@ -5,14 +5,14 @@ let
assertion = lib.mkOption {
type = lib.types.functionTo lib.types.bool;
description = ''
Predicate run against this registry's flattened collected entries.
Tests this registry's flattened collected entries.
'';
};
message = lib.mkOption {
type = lib.types.str;
description = ''
Error message shown when this registry validation check fails.
Describes the registry validation failure.
'';
};
};
@@ -23,7 +23,7 @@ in
type = lib.mkOption {
type = lib.types.raw;
description = ''
NixOS option type for one registry entry.
Defines the NixOS option type for one registry entry.
'';
};
@@ -31,7 +31,7 @@ in
type = lib.types.bool;
default = false;
description = ''
Whether collected entries are merged and published under every host key.
Replicates collected entries under every host key.
'';
};
@@ -39,7 +39,7 @@ in
type = lib.types.listOf checkType;
default = [ ];
description = ''
Validation checks for this registry's flattened collected entries.
Contains validation checks for this registry's flattened collected entries.
'';
};
};