diff options
| author | Colin Arnott <colin@urandom.co.uk> | 2023-01-30 21:22:02 +0000 |
|---|---|---|
| committer | Colin Arnott <colin@urandom.co.uk> | 2023-01-30 23:53:44 +0000 |
| commit | 6ff66fcbd70c7d588bbf6e3b2cd41aa7d8a62fd2 (patch) | |
| tree | 2514e62f38e786c506c5cd461d592f4291f1557c /lib/options.nix | |
| parent | 24525805b68d83b5f578db887040303c069fa710 (diff) | |
| download | nixpkgs-6ff66fcbd70c7d588bbf6e3b2cd41aa7d8a62fd2.tar nixpkgs-6ff66fcbd70c7d588bbf6e3b2cd41aa7d8a62fd2.tar.gz nixpkgs-6ff66fcbd70c7d588bbf6e3b2cd41aa7d8a62fd2.tar.bz2 nixpkgs-6ff66fcbd70c7d588bbf6e3b2cd41aa7d8a62fd2.tar.lz nixpkgs-6ff66fcbd70c7d588bbf6e3b2cd41aa7d8a62fd2.tar.xz nixpkgs-6ff66fcbd70c7d588bbf6e3b2cd41aa7d8a62fd2.tar.zst nixpkgs-6ff66fcbd70c7d588bbf6e3b2cd41aa7d8a62fd2.zip | |
lib: standardise attrset type syntax
There are a number of different syntaxes used for attrset type signatures in our doc strings, this change standardises upon one that uses :: for specifying attribute type, and ; terminators to be consistent with nix syntax. There are no bugs in the functions themselves, just that different syntaxes may confuse new users.
Diffstat (limited to 'lib/options.nix')
| -rw-r--r-- | lib/options.nix | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/options.nix b/lib/options.nix index ce66bfb9d5d..d14d209a834 100644 --- a/lib/options.nix +++ b/lib/options.nix @@ -114,7 +114,7 @@ rec { You can omit the default path if the name of the option is also attribute path in nixpkgs. - Type: mkPackageOption :: pkgs -> string -> { default :: [string], example :: null | string | [string] } -> option + Type: mkPackageOption :: pkgs -> string -> { default :: [string]; example :: null | string | [string]; } -> option Example: mkPackageOption pkgs "hello" { } @@ -201,7 +201,7 @@ rec { /* Extracts values of all "value" keys of the given list. - Type: getValues :: [ { value :: a } ] -> [a] + Type: getValues :: [ { value :: a; } ] -> [a] Example: getValues [ { value = 1; } { value = 2; } ] // => [ 1 2 ] @@ -211,7 +211,7 @@ rec { /* Extracts values of all "file" keys of the given list - Type: getFiles :: [ { file :: a } ] -> [a] + Type: getFiles :: [ { file :: a; } ] -> [a] Example: getFiles [ { file = "file1"; } { file = "file2"; } ] // => [ "file1" "file2" ] |