Skip to content

docs/mkOption: improve mkOption documentation #478096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hsjobeki merged 1 commit into from
Jan 15, 2026
+8 −8
Merged

docs/mkOption: improve mkOption documentation #478096

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions lib/options.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,12 @@ rec {
isOption = lib.isType "option";

/**
Creates an Option attribute set. `mkOption` accepts an attribute set with the following keys:
Creates an Option declaration for use with the module system.

# Inputs

Structured attribute set
: Attribute set containing none or some of the following attributes.
Attribute set
: containing none or some of the following attributes.

`default`
: Optional default value used when no definition is given in the configuration.
Expand Down Expand Up @@ -122,16 +122,16 @@ rec {
`readOnly`
: Optional boolean indicating whether the option can be set only once.

`...` (any other attribute)
: Any other attribute is passed through to the resulting option attribute set.

# Examples
:::{.example}
## `lib.options.mkOption` usage example

```nix
mkOption { } // => { _type = "option"; }
mkOption { default = "foo"; } // => { _type = "option"; default = "foo"; }
mkOption { }
# => Empty option; type = types.anything

mkOption { default = "foo"; }
# => Same as above, with a default value
```

:::
Expand Down
Loading