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

bash, fish, zsh: fix shellAliases example

Browse source 
Unfortunately the document generator is not smart enough to quote the
`..` alias in the documentation which is very misleading. By making it
a literal example the quotes stay.
This commit is contained in:
Robert Helgesson 2020-02-26 22:44:54 +01:00
parent 02d6040003
commit 2f726bbd1c
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89
3 changed files with 18 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
modules/programs/bash.nix
View file

@ -82,7 +82,12 @@ in
shellAliases = mkOption {
default = {};
type = types.attrsOf types.str;
example = { ll = "ls -l"; ".." = "cd .."; };
example = literalExample ''
{
ll = "ls -l";
".." = "cd ..";
}
'';
description = ''
An attribute set that maps aliases (the top level attribute names in
this option) to command strings or directly to build outputs.

10
modules/programs/fish.nix
View file

@ -53,10 +53,12 @@ in {
shellAliases = mkOption {
type = with types; attrsOf str;
default = { };
example = {
".." = "cd ..";
ll = "ls -l";
};
example = literalExample ''
{
ll = "ls -l";
".." = "cd ..";
}
'';
description = ''
An attribute set that maps aliases (the top level attribute names
in this option) to command strings or directly to build outputs.

7
modules/programs/zsh.nix
View file

@ -183,7 +183,12 @@ in
shellAliases = mkOption {
default = {};
example = { ll = "ls -l"; ".." = "cd .."; };
example = literalExample ''
{
ll = "ls -l";
".." = "cd ..";
}
'';
description = ''
An attribute set that maps aliases (the top level attribute names in
this option) to command strings or directly to build outputs.