mirror of
https://github.com/nix-community/home-manager
synced 2024-12-24 02:39:48 +01:00
bash, fish, zsh: fix shellAliases example
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:
parent
02d6040003
commit
2f726bbd1c
3 changed files with 18 additions and 6 deletions
|
@ -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.
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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.
|
||||
|
|
Loading…
Reference in a new issue