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

treewide: remove now-redundant lib.mdDoc calls

Browse source 
These (and the `*MD` functions apart from `literalMD`) are now no-ops
in nixpkgs and serve no purpose other than to add additional noise and
potentially mislead people into thinking unmarked DocBook documentation
will still be accepted.

Note that if backporting changes including documentation to 23.05,
the `mdDoc` calls will need to be re-added.

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 \
      --strip {} +
    $ ./format
This commit is contained in:
Emily 2023-07-02 00:45:18 +01:00
parent 7398af11b8
commit 9f9e277b60
360 changed files with 2672 additions and 2853 deletions
Download patch file Download diff file Expand all files Collapse all files

45
modules/programs/fish.nix
View file

@ -10,7 +10,7 @@ let
options = {
src = mkOption {
type = types.path;
description = lib.mdDoc ''
description = ''
Path to the plugin folder.
Relevant pieces will be added to the fish function path and
@ -22,7 +22,7 @@ let
name = mkOption {
type = types.str;
description = lib.mdDoc ''
description = ''
The name of the plugin.
'';
};
@ -33,7 +33,7 @@ let
options = {
body = mkOption {
type = types.lines;
description = lib.mdDoc ''
description = ''
The function body.
'';
};
@ -41,7 +41,7 @@ let
argumentNames = mkOption {
type = with types; nullOr (either str (listOf str));
default = null;
description = lib.mdDoc ''
description = ''
Assigns the value of successive command line arguments to the names
given.
'';
@ -50,7 +50,7 @@ let
description = mkOption {
type = with types; nullOr str;
default = null;
description = lib.mdDoc ''
description = ''
A description of what the function does, suitable as a completion
description.
'';
@ -59,7 +59,7 @@ let
wraps = mkOption {
type = with types; nullOr str;
default = null;
description = lib.mdDoc ''
description = ''
Causes the function to inherit completions from the given wrapped
command.
'';
@ -68,7 +68,7 @@ let
onEvent = mkOption {
type = with types; nullOr str;
default = null;
description = lib.mdDoc ''
description = ''
Tells fish to run this function when the specified named event is
emitted. Fish internally generates named events e.g. when showing the
prompt.
@ -78,7 +78,7 @@ let
onVariable = mkOption {
type = with types; nullOr str;
default = null;
description = lib.mdDoc ''
description = ''
Tells fish to run this function when the specified variable changes
value.
'';
@ -87,7 +87,7 @@ let
onJobExit = mkOption {
type = with types; nullOr (either str int);
default = null;
description = lib.mdDoc ''
description = ''
Tells fish to run this function when the job with the specified group
ID exits. Instead of a PID, the stringer `caller` can
be specified. This is only legal when in a command substitution, and
@ -100,7 +100,7 @@ let
type = with types; nullOr (either str int);
default = null;
example = "$fish_pid";
description = lib.mdDoc ''
description = ''
Tells fish to run this function when the fish child process with the
specified process ID exits. Instead of a PID, for backwards
compatibility, `%self` can be specified as an alias
@ -113,7 +113,7 @@ let
type = with types; nullOr (either str int);
default = null;
example = [ "SIGHUP" "HUP" 1 ];
description = lib.mdDoc ''
description = ''
Tells fish to run this function when the specified signal is
delievered. The signal can be a signal number or signal name.
'';
@ -122,7 +122,7 @@ let
noScopeShadowing = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Allows the function to access the variables of calling functions.
'';
};
@ -130,7 +130,7 @@ let
inheritVariable = mkOption {
type = with types; nullOr str;
default = null;
description = lib.mdDoc ''
description = ''
Snapshots the value of the specified variable and defines a local
variable with that same name and value when the function is defined.
'';
@ -172,14 +172,13 @@ in {
options = {
programs.fish = {
enable =
mkEnableOption (lib.mdDoc "fish, the friendly interactive shell");
enable = mkEnableOption "fish, the friendly interactive shell";
package = mkOption {
type = types.package;
default = pkgs.fish;
defaultText = literalExpression "pkgs.fish";
description = lib.mdDoc ''
description = ''
The fish package to install. May be used to change the version.
'';
};
@ -193,7 +192,7 @@ in {
"..." = "cd ../..";
}
'';
description = lib.mdDoc ''
description = ''
An attribute set that maps aliases (the top level attribute names
in this option) to command strings or directly to build outputs.
'';
@ -206,7 +205,7 @@ in {
l = "less";
gco = "git checkout";
};
description = lib.mdDoc ''
description = ''
An attribute set that maps aliases (the top level attribute names
in this option) to abbreviations. Abbreviations are expanded with
the longer phrase after they are entered.
@ -216,7 +215,7 @@ in {
shellInit = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during fish shell
initialisation.
'';
@ -225,7 +224,7 @@ in {
loginShellInit = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during fish login shell
initialisation.
'';
@ -234,7 +233,7 @@ in {
interactiveShellInit = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during interactive fish shell
initialisation.
'';
@ -269,7 +268,7 @@ in {
}
]
'';
description = lib.mdDoc ''
description = ''
The plugins to source in
{file}`conf.d/99plugins.fish`.
'';
@ -288,7 +287,7 @@ in {
gitignore = "curl -sL https://www.gitignore.io/api/$argv";
}
'';
description = lib.mdDoc ''
description = ''
Basic functions to add to fish. For more information see
<https://fishshell.com/docs/current/cmds/function.html>.
'';