Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Thanks @infinisil

Co-authored-by: Silvan Mosberger <[email protected]>
  • Loading branch information
hsjobeki and infinisil authored Jun 27, 2024
1 parent 59b7511 commit 9c954a8
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions lib/options.nix
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,16 @@ rec {
/**
Creates an Option attribute set. mkOption accepts an attribute set with the following keys:
All keys default to `null` when not given.
# Inputs
Structured attribute set
: Attribute set containing none or some of the following attributes.
`default`
: Optional default value used when no definition is given in the configuration.
_Default:_ None, when the option is evaluated an error is thrown.
`defaultText`
Expand All @@ -96,7 +97,7 @@ rec {
: Optional example value used in the manual.
`description`
: Optional string describing the option.
: Optional string describing the option. This is required if option documentation is generated.
`relatedPackages`
: Optional related packages used in the manual (see `genRelatedPackages` in `../nixos/lib/make-options-doc/default.nix`).
Expand Down

0 comments on commit 9c954a8

Please sign in to comment.