From 8813c6106e252c5a019d0e33e372e1949701b099 Mon Sep 17 00:00:00 2001 From: Peder Bergebakken Sundt Date: Wed, 14 Aug 2024 03:49:23 +0200 Subject: [PATCH] nixos/README.md: relax the requirement of providing option defaults If we enforce the requirement of option defaults to the extreme, then we end up with silly sentinel values, a bunch of nullable types, and assertions checking for sentinel values. --- nixos/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/nixos/README.md b/nixos/README.md index 5f751e10e20a0..5b6f789bfc417 100644 --- a/nixos/README.md +++ b/nixos/README.md @@ -83,6 +83,9 @@ Reviewing process: - Ensure that the introduced options are correct. - Type should be appropriate (string related types differs in their merging capabilities, `loaOf` and `string` types are deprecated). - Description, default and example should be provided. + - Defaults may only be omitted if both: + 1. The user is required to set it in order to use the service. + 2. The lack of a default does not break evaluation when the the module is not enabled. - Ensure that module `meta` field is present - Maintainers should be declared in `meta.maintainers`. - Module documentation should be declared with `meta.doc`.