diff options
author | pennae <github@quasiparticle.net> | 2023-02-08 09:57:21 +0100 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2023-02-10 06:40:00 +0100 |
commit | 816365133831b90b0f5c883e4a1b43fdeb2db054 (patch) | |
tree | bdef4fe271fab9f50dc314ade40037693b2811a7 /nixos/doc/manual/development | |
parent | ba4bcdc5e4999c5657063399f76dedf5c84fa56e (diff) |
nixos/manual: fix option-declarations sections
the examples for mkPackageOption weren't terminated, leading to pretty odd nesting of docbook (and thus html) elements. close them properly. also turn the (likewise unclosed) fenced div containing just an anchor id and a class that will be silently dropped to an inline anchor while we're here. we'd have to convert it anyway later.
Diffstat (limited to 'nixos/doc/manual/development')
-rw-r--r-- | nixos/doc/manual/development/option-declarations.section.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/nixos/doc/manual/development/option-declarations.section.md b/nixos/doc/manual/development/option-declarations.section.md index 18ec7ba903a9f..0b965647bab75 100644 --- a/nixos/doc/manual/development/option-declarations.section.md +++ b/nixos/doc/manual/development/option-declarations.section.md @@ -87,6 +87,7 @@ lib.mkOption { description = lib.mdDoc "Whether to enable magic."; } ``` +::: ### `mkPackageOption`, `mkPackageOptionMD` {#sec-option-declarations-util-mkPackageOption} @@ -108,7 +109,7 @@ You can omit the default path if the name of the option is also attribute path i During the transition to CommonMark documentation `mkPackageOption` creates an option with a DocBook description attribute, once the transition is completed it will create a CommonMark description instead. `mkPackageOptionMD` always creates an option with a CommonMark description attribute and will be removed some time after the transition is completed. -::: {#ex-options-declarations-util-mkPackageOption .title} +[]{#ex-options-declarations-util-mkPackageOption} Examples: ::: {#ex-options-declarations-util-mkPackageOption-hello .example} @@ -122,6 +123,7 @@ lib.mkOption { description = lib.mdDoc "The hello package to use."; } ``` +::: ::: {#ex-options-declarations-util-mkPackageOption-ghc .example} ```nix @@ -138,6 +140,7 @@ lib.mkOption { description = lib.mdDoc "The GHC package to use."; } ``` +::: ## Extensible Option Types {#sec-option-declarations-eot} |