From 4f2d2c9446e01d86e1330ba5026769afb903ba86 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Thu, 27 Jun 2024 09:24:22 +0200 Subject: [PATCH] Apply suggestions from code review Thanks @infinisil Co-authored-by: Silvan Mosberger --- lib/options.nix | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/lib/options.nix b/lib/options.nix index 437e1c4b85176..3686b6f5fba81 100644 --- a/lib/options.nix +++ b/lib/options.nix @@ -78,8 +78,6 @@ rec { /** Creates an Option attribute set. mkOption accepts an attribute set with the following keys: - All keys default to `null` when not given. - # Inputs Structured attribute set @@ -87,6 +85,9 @@ rec { `default` : Optional default value used when no definition is given in the configuration. + + _Default:_ None, when the option is evaluated an error is thrown. + `defaultText` @@ -101,7 +102,7 @@ rec { : Usage with `lib.literalMD` or `lib.literalExpression` is supported `description` - : Optional string describing the option. + : Optional string describing the option. This is required if option documentation is generated. `relatedPackages` : Optional related packages used in the manual (see `genRelatedPackages` in `../nixos/lib/make-options-doc/default.nix`).