From e054fe2bc0d5f001c879d33d8e5464bfc7099417 Mon Sep 17 00:00:00 2001 From: Matt Sturgeon Date: Mon, 1 Jul 2024 13:59:02 +0100 Subject: [PATCH] contributing: add note clarifying freeform `settings` --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6287f41c..837fa684 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,9 +68,13 @@ The resulting `settings` attrs will be directly translated to `lua` and will be In either case, you don't need to bother implementing this part. It is done automatically. -> [!NOTE] +> [!TIP] > Learn more about the [RFC 42](https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md) which motivated this new approach. +> [!NOTE] +> `settings` has a "freeform" type `attrsOf anything`, meaning it can be configured with _anything_. +> Declaring `settingsOptions` is therefore optional and just adds type-checking and documentation. + ### Tests