about summary refs log tree commit diff
path: root/nixos/modules/programs/zsh
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2022-08-14 09:03:30 +0200
committerpennae <82953136+pennae@users.noreply.github.com>2022-08-19 22:40:58 +0200
commit7e7d68a250f75678451cd44f8c3d585bf750461e (patch)
treeed5d8dc84de9f9651eb331a34c41b1c5b2197ef7 /nixos/modules/programs/zsh
parentb51f8036c2c4e887ce45372dc6b7a4c4a54a0ea0 (diff)
downloadnixlib-7e7d68a250f75678451cd44f8c3d585bf750461e.tar
nixlib-7e7d68a250f75678451cd44f8c3d585bf750461e.tar.gz
nixlib-7e7d68a250f75678451cd44f8c3d585bf750461e.tar.bz2
nixlib-7e7d68a250f75678451cd44f8c3d585bf750461e.tar.lz
nixlib-7e7d68a250f75678451cd44f8c3d585bf750461e.tar.xz
nixlib-7e7d68a250f75678451cd44f8c3d585bf750461e.tar.zst
nixlib-7e7d68a250f75678451cd44f8c3d585bf750461e.zip
nixos/*: mark pre-existing markdown descriptions as mdDoc
Diffstat (limited to 'nixos/modules/programs/zsh')
-rw-r--r--nixos/modules/programs/zsh/oh-my-zsh.nix8
-rw-r--r--nixos/modules/programs/zsh/zsh-autoenv.nix2
-rw-r--r--nixos/modules/programs/zsh/zsh-autosuggestions.nix2
3 files changed, 6 insertions, 6 deletions
diff --git a/nixos/modules/programs/zsh/oh-my-zsh.nix b/nixos/modules/programs/zsh/oh-my-zsh.nix
index b253b803edcc..41ea31b0f122 100644
--- a/nixos/modules/programs/zsh/oh-my-zsh.nix
+++ b/nixos/modules/programs/zsh/oh-my-zsh.nix
@@ -49,7 +49,7 @@ in
         package = mkOption {
           default = pkgs.oh-my-zsh;
           defaultText = literalExpression "pkgs.oh-my-zsh";
-          description = ''
+          description = lib.mdDoc ''
             Package to install for `oh-my-zsh` usage.
           '';
 
@@ -67,7 +67,7 @@ in
         custom = mkOption {
           default = null;
           type = with types; nullOr str;
-          description = ''
+          description = lib.mdDoc ''
             Path to a custom oh-my-zsh package to override config of oh-my-zsh.
             (Can't be used along with `customPkgs`).
           '';
@@ -76,7 +76,7 @@ in
         customPkgs = mkOption {
           default = [];
           type = types.listOf types.package;
-          description = ''
+          description = lib.mdDoc ''
             List of custom packages that should be loaded into `oh-my-zsh`.
           '';
         };
@@ -92,7 +92,7 @@ in
         cacheDir = mkOption {
           default = "$HOME/.cache/oh-my-zsh";
           type = types.str;
-          description = ''
+          description = lib.mdDoc ''
             Cache directory to be used by `oh-my-zsh`.
             Without this option it would default to the read-only nix store.
           '';
diff --git a/nixos/modules/programs/zsh/zsh-autoenv.nix b/nixos/modules/programs/zsh/zsh-autoenv.nix
index 62f497a45dd0..46fc4d49c597 100644
--- a/nixos/modules/programs/zsh/zsh-autoenv.nix
+++ b/nixos/modules/programs/zsh/zsh-autoenv.nix
@@ -11,7 +11,7 @@ in {
       package = mkOption {
         default = pkgs.zsh-autoenv;
         defaultText = literalExpression "pkgs.zsh-autoenv";
-        description = ''
+        description = lib.mdDoc ''
           Package to install for `zsh-autoenv` usage.
         '';
 
diff --git a/nixos/modules/programs/zsh/zsh-autosuggestions.nix b/nixos/modules/programs/zsh/zsh-autosuggestions.nix
index b6c36a082e77..92a3fc081370 100644
--- a/nixos/modules/programs/zsh/zsh-autosuggestions.nix
+++ b/nixos/modules/programs/zsh/zsh-autosuggestions.nix
@@ -24,7 +24,7 @@ in
     strategy = mkOption {
       type = types.listOf (types.enum [ "history" "completion" "match_prev_cmd" ]);
       default = [ "history" ];
-      description = ''
+      description = lib.mdDoc ''
         `ZSH_AUTOSUGGEST_STRATEGY` is an array that specifies how suggestions should be generated.
         The strategies in the array are tried successively until a suggestion is found.
         There are currently three built-in strategies to choose from: