1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2025-11-08 19:46:05 +01:00

treewide: convert options with lists to Markdown

`nix-doc-munge` can't handle these, which is understandable as I can
barely handle them either. There are a few infelicities here: the
current processor can't handle multiple terms to one description in
a description list so they get comma-separated in one case, and one
case that should ideally render as a `<figure>` with a `<figcaption>`
in HTML is reduced to a paragraph with some `<strong>` text. (Which, in
fairness, is how it rendered in practice with the DocBook anyway.) The
docs generator has since been updated to handle figures, but we can't
use it until moving off DocBook output.
This commit is contained in:
Emily 2023-07-01 01:40:42 +01:00
parent 9e4a73c25e
commit 21c700d14b
13 changed files with 341 additions and 531 deletions

View file

@ -174,23 +174,19 @@ in {
OpenTmuxWindowsIn = mkNullableOption {
type = types.int;
example = 2;
description = ''
description = lib.mdDoc ''
Configures how to restore tmux windows when attaching to a session.
<variablelist><title>Possible Values</title>
<varlistentry>
<term><literal>0</literal></term>
<listitem><para>Native windows</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>1</literal></term>
<listitem><para>Native tabs in a new window</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>2</literal></term>
<listitem><para>Tabs in the attaching window</para></listitem>
</varlistentry>
</variablelist>
**Possible Values**
`0`
: Native windows
`1`
: Native tabs in a new window
`2`
: Tabs in the attaching window
'';
};