diff options
author | pennae <github@quasiparticle.net> | 2022-06-03 21:47:57 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-06-12 12:44:38 +0200 |
commit | 320aa2a7910a71371204d672ff612cc9af5337da (patch) | |
tree | 05aaeaff9dbee1e701b999752badcb97728c265f /lib/options.nix | |
parent | 2f00d7ac51207d061fb9174b130ae3bb8b2d651a (diff) |
treewide: attempt at markdown option docs
Diffstat (limited to 'lib/options.nix')
-rw-r--r-- | lib/options.nix | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/options.nix b/lib/options.nix index 8d82a809083b7..50b19e4837360 100644 --- a/lib/options.nix +++ b/lib/options.nix @@ -280,6 +280,21 @@ rec { if ! isString text then throw "literalDocBook expects a string." else { _type = "literalDocBook"; inherit text; }; + /* Transition marker for documentation that's already migrated to markdown + syntax. + */ + mdDoc = text: + if ! isString text then throw "mdDoc expects a string." + else { _type = "mdDoc"; inherit text; }; + + /* For use in the `defaultText` and `example` option attributes. Causes the + given MD text to be inserted verbatim in the documentation, for when + a `literalExpression` would be too hard to read. + */ + literalMD = text: + if ! isString text then throw "literalMD expects a string." + else { _type = "literalMD"; inherit text; }; + # Helper functions. /* Convert an option, described as a list of the option parts in to a |