diff options
| author | Robert Hensing <roberth@users.noreply.github.com> | 2022-03-16 22:58:45 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-16 22:58:45 +0100 |
| commit | 0395086d0c2bb189f03985486a23cfedbdf8c940 (patch) | |
| tree | 621948aafdf70a1adc44b344ab93650bef22cc50 /nixos/doc/manual/development | |
| parent | 2f7633c22ee80c72a206421abcd5fc1a208bf946 (diff) | |
| parent | 0c766a100e416611807a184ee35a0edbd11b15a4 (diff) | |
| download | nixpkgs-0395086d0c2bb189f03985486a23cfedbdf8c940.tar nixpkgs-0395086d0c2bb189f03985486a23cfedbdf8c940.tar.gz nixpkgs-0395086d0c2bb189f03985486a23cfedbdf8c940.tar.bz2 nixpkgs-0395086d0c2bb189f03985486a23cfedbdf8c940.tar.lz nixpkgs-0395086d0c2bb189f03985486a23cfedbdf8c940.tar.xz nixpkgs-0395086d0c2bb189f03985486a23cfedbdf8c940.tar.zst nixpkgs-0395086d0c2bb189f03985486a23cfedbdf8c940.zip | |
Merge pull request #162271 from Infinisil/warn-no-type
Throw an error for options without a type
Diffstat (limited to 'nixos/doc/manual/development')
| -rw-r--r-- | nixos/doc/manual/development/option-declarations.section.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/nixos/doc/manual/development/option-declarations.section.md b/nixos/doc/manual/development/option-declarations.section.md index 819fc6d891f..53ecb9b3a62 100644 --- a/nixos/doc/manual/development/option-declarations.section.md +++ b/nixos/doc/manual/development/option-declarations.section.md @@ -27,9 +27,10 @@ The function `mkOption` accepts the following arguments. `type` -: The type of the option (see [](#sec-option-types)). It may be - omitted, but that's not advisable since it may lead to errors that - are hard to diagnose. +: The type of the option (see [](#sec-option-types)). This + argument is mandatory for nixpkgs modules. Setting this is highly + recommended for the sake of documentation and type checking. In case it is + not set, a fallback type with unspecified behavior is used. `default` |