nix/2.home-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

treewide: convert all option docs to Markdown

Browse source 
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:
Emily 2023-07-01 00:30:13 +01:00
parent c1d8d2a3d1
commit 36a53d9f26
355 changed files with 3805 additions and 3886 deletions
Download patch file Download diff file Expand all files Collapse all files

32
modules/programs/ncmpcpp.nix
View file

@ -31,13 +31,14 @@ let
options = {
key = mkOption {
type = types.str;
description = "Key to bind.";
description = lib.mdDoc "Key to bind.";
example = "j";
};
command = mkOption {
type = with types; either str (listOf str);
description = "Command or sequence of commands to be executed.";
description =
lib.mdDoc "Command or sequence of commands to be executed.";
example = "scroll_down";
};
};
@ -47,15 +48,15 @@ in {
meta.maintainers = [ hm.maintainers.olmokramer ];
options.programs.ncmpcpp = {
enable =
mkEnableOption "ncmpcpp - an ncurses Music Player Daemon (MPD) client";
enable = mkEnableOption
(lib.mdDoc "ncmpcpp - an ncurses Music Player Daemon (MPD) client");
package = mkOption {
type = types.package;
default = pkgs.ncmpcpp;
defaultText = literalExpression "pkgs.ncmpcpp";
description = ''
Package providing the <literal>ncmpcpp</literal> command.
description = lib.mdDoc ''
Package providing the `ncmpcpp` command.
'';
example =
literalExpression "pkgs.ncmpcpp.override { visualizerSupport = true; }";
@ -74,11 +75,11 @@ in {
else
null
'';
description = ''
Value of the <literal>mpd_music_dir</literal> setting. On Linux platforms the
value of <varname>services.mpd.musicDirectory</varname> is used as the
default if <varname>services.mpd.enable</varname> is
<literal>true</literal>.
description = lib.mdDoc ''
Value of the `mpd_music_dir` setting. On Linux platforms the
value of {var}`services.mpd.musicDirectory` is used as the
default if {var}`services.mpd.enable` is
`true`.
'';
example = "~/music";
};
@ -86,13 +87,10 @@ in {
settings = mkOption {
type = types.attrsOf valueType;
default = { };
description = ''
description = lib.mdDoc ''
Attribute set from name of a setting to its value. For available options
see
<citerefentry>
<refentrytitle>ncmpcpp</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>.
{manpage}`ncmpcpp(1)`.
'';
example = { ncmpcpp_directory = "~/.local/share/ncmpcpp"; };
};
@ -100,7 +98,7 @@ in {
bindings = mkOption {
type = types.listOf bindingType;
default = [ ];
description = "List of keybindings.";
description = lib.mdDoc "List of keybindings.";
example = literalExpression ''
[
{ key = "j"; command = "scroll_down"; }