mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 00:25:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

contributing: add note clarifying freeform settings

Browse source
This commit is contained in:
Matt Sturgeon 2024-07-01 13:59:02 +01:00 • committed by MattSturgeon
parent 71b8d0b327
commit e054fe2bc0
1 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -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. 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. > 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 ### Tests