Merge branch 'main' into lualine-separators

docs: working example for `vim.diagnostics.config.signs`

docs/manual/tips/pure-lua-config.md

@@ -23,7 +23,7 @@ manner.
   # flake.nix. For the sake of the argument, we will assume that the Neovim lua
   # configuration is in a nvim/ directory relative to flake.nix.
   vim = {
-    additionalRuntimeDirectories = [
+    additionalRuntimePaths = [
       # This will be added to Neovim's runtime paths. Conceptually, this behaves
       # very similarly to ~/.config/nvim but you may not place a top-level
       # init.lua to be able to require it directly.
@@ -41,7 +41,7 @@ directory, and call it with [](#opt-vim.luaConfigRC).
 ```nix
 {pkgs, ...}: {
   vim = {
-    additionalRuntimeDirectories = [
+    additionalRuntimePaths = [
       # You can list more than one file here.
       ./nvim-custom-1
 

modules/neovim/init/clipboard.nix

@@ -20,7 +20,7 @@ in {
         '';
 
         registers = mkOption {
-          type = either str (listOf str);
+          type = str;
           default = "";
           example = "unnamedplus";
           description = ''
@@ -33,8 +33,8 @@ in {
             `"+"` ({command}`:h quoteplus`) instead of register `"*"` for all yank, delete,
             change and put operations which would normally go to the unnamed register.
 
-            When `unnamed` and `unnamedplus` is included simultaneously yank and delete
-            operations (but not put) will additionally copy the text into register `"*"`.
+            When `unnamed` and `unnamedplus` is included simultaneously as `"unnamed,unnamedplus"`,
+            yank and delete operations (but not put) will additionally copy the text into register `"*"`.
 
             Please see  {command}`:h clipboard` for more details.
 

modules/neovim/init/diagnostics.nix

@@ -57,14 +57,21 @@
       signs = mkOption {
         type = diagnosticType;
         default = false;
-        example = {
-          signs.text = {
-            "vim.diagnostic.severity.ERROR" = "󰅚 ";
-            "vim.diagnostic.severity.WARN" = "󰀪 ";
-          };
-        };
+        example = literalExpression ''
+          signs.text = lib.generators.mkLuaInline '''
+            {
+              [vim.diagnostic.severity.ERROR] = "󰅚 ",
+              [vim.diagnostic.severity.WARN] = "󰀪 ",
+            }
+          ''';
+        '';
         description = ''
           Use signs for diagnostics. See {command}`:help diagnostic-signs`.
+
+          :::{.note}
+          The code presented in that example section uses Lua expressions as object keys which
+          only translate well if you use `lib.generators.mkLuaInline` as in the example.
+          :::
         '';
       };