diff options
| author | Klemens Nanni <klemens@posteo.de> | 2022-04-27 05:42:16 +0200 |
|---|---|---|
| committer | Klemens Nanni <klemens@posteo.de> | 2022-04-27 05:59:46 +0200 |
| commit | 7bec3e60efb9203c444bfaf8f35cfb1252ece170 (patch) | |
| tree | fd99f9360db9fe84ffe6c15e1a2c3a40d8f44f67 /lib | |
| parent | git-cliff: 0.6.1 -> 0.7.0 (diff) | |
| download | nixpkgs-7bec3e60efb9203c444bfaf8f35cfb1252ece170.tar.gz | |
lib/types: Drop misleading plural from type descriptions #170561
Probably being the most prominent document demonstrating the problem,
configuration.nix(5) describes various types in plural, e.g.
- ` Type: list of strings`
- ` Type: list of systemd options`
However, there are other cases where appending "s" to the inner type
effectively changes the type, e.g.
- ```
Type: list of string matching the pattern
[a-zA-Z0-9@%:_.\-]+[.](service|socket|device|mount|automount|swap|target|path|timer|scope|slice)s
```
This should've read "list of string[s]..." but instead changes the
regular expression.
Simply drop the best-effort plural in favour of correctness and
simplicity rather than adding more grammar related logic/trying to fix
this.
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/types.nix | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/types.nix b/lib/types.nix index 91b040d24553..e4b3f358d1c9 100644 --- a/lib/types.nix +++ b/lib/types.nix @@ -397,7 +397,7 @@ rec { listOf = elemType: mkOptionType rec { name = "listOf"; - description = "list of ${elemType.description}s"; + description = "list of ${elemType.description}"; check = isList; merge = loc: defs: map (x: x.value) (filter (x: x ? value) (concatLists (imap1 (n: def: @@ -426,7 +426,7 @@ rec { attrsOf = elemType: mkOptionType rec { name = "attrsOf"; - description = "attribute set of ${elemType.description}s"; + description = "attribute set of ${elemType.description}"; check = isAttrs; merge = loc: defs: mapAttrs (n: v: v.value) (filterAttrs (n: v: v ? value) (zipAttrsWith (name: defs: @@ -449,7 +449,7 @@ rec { # error that it's not defined. Use only if conditional definitions don't make sense. lazyAttrsOf = elemType: mkOptionType rec { name = "lazyAttrsOf"; - description = "lazy attribute set of ${elemType.description}s"; + description = "lazy attribute set of ${elemType.description}"; check = isAttrs; merge = loc: defs: zipAttrsWith (name: defs: |