options: mkOption docs update

This commit is contained in:
Malix - Alix Brunet
2026-07-14 13:36:34 +02:00
committed by GitHub
parent 16d4309bb1
commit fa23725d3b
+2 -2
View File
@@ -90,12 +90,12 @@ rec {
`defaultText`
: Substitute for documenting the `default`, if evaluating the default value during documentation rendering is not possible.
: Can be any nix value that evaluates.
: Usage with `lib.literalMD` or `lib.literalExpression` is supported
: Usage with `lib.literalMD`, `lib.literalExpression`, or `lib.literalCode` is supported
`example`
: Optional example value used in the manual.
: Can be any nix value that evaluates.
: Usage with `lib.literalMD` or `lib.literalExpression` is supported
: Usage with `lib.literalMD`, `lib.literalExpression`, or `lib.literalCode` is supported
`description`
: Optional string describing the option. This is required if option documentation is generated.