treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.
To reproduce this commit, run:
$ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
nix shell nixpkgs#coreutils \
-c find . -name '*.nix' \
-exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
{} +
$ ./format
[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
This commit is contained in:
parent
c1d8d2a3d1
commit
36a53d9f26
355 changed files with 3805 additions and 3886 deletions
|
|
@ -13,13 +13,14 @@ in {
|
|||
|
||||
options = {
|
||||
programs.tiny = {
|
||||
enable = mkEnableOption "tiny, a TUI IRC client written in Rust";
|
||||
enable =
|
||||
mkEnableOption (lib.mdDoc "tiny, a TUI IRC client written in Rust");
|
||||
|
||||
package = mkOption {
|
||||
type = types.package;
|
||||
default = pkgs.tiny;
|
||||
defaultText = literalExpression "pkgs.tiny";
|
||||
description = "The <command>tiny</command> package to install.";
|
||||
description = lib.mdDoc "The {command}`tiny` package to install.";
|
||||
};
|
||||
|
||||
settings = mkOption {
|
||||
|
|
@ -45,10 +46,10 @@ in {
|
|||
};
|
||||
};
|
||||
'';
|
||||
description = ''
|
||||
description = lib.mdDoc ''
|
||||
Configuration written to
|
||||
<filename>$XDG_CONFIG_HOME/tiny/config.yml</filename>. See
|
||||
<link xlink:href="https://github.com/osa1/tiny/blob/master/crates/tiny/config.yml"/>
|
||||
{file}`$XDG_CONFIG_HOME/tiny/config.yml`. See
|
||||
<https://github.com/osa1/tiny/blob/master/crates/tiny/config.yml>
|
||||
for the default configuration.
|
||||
'';
|
||||
};
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue