lib.literalExpression: add example and properly describe function arg

2026-06-05 21:03:40 +00:00 · 2025-12-07 15:43:03 +00:00
parent 7c7abab0c4
commit 4d2e351d55
1 changed files with 20 additions and 1 deletions
--- a/lib/options.nix
+++ b/lib/options.nix
@@ -672,11 +672,30 @@ rec {
    is necessary for complex values, e.g. functions, or values that depend on
    other values or packages.

+    # Examples
+    :::{.example}
+    ## `literalExpression` usage example
+
+    ```nix
+    llvmPackages = mkOption {
+      type = types.str;
+      description = ''
+        Version of llvm packages to use for
+        this module
+      '';
+      example = literalExpression ''
+        llvmPackages = pkgs.llvmPackages_20;
+      '';
+    };
+    ```
+
+    :::
+
    # Inputs

    `text`

-    : 1\. Function argument
+    : The text to render as a Nix expression
  */
  literalExpression =
    text: