diff --git a/modules/home-environment.nix b/modules/home-environment.nix index 2c335ba9e..41196186d 100644 --- a/modules/home-environment.nix +++ b/modules/home-environment.nix @@ -100,7 +100,9 @@ in options = { target = mkOption { type = types.str; - description = "Path to target file relative to $HOME."; + description = '' + Path to target file relative to HOME. + ''; }; text = mkOption { @@ -147,6 +149,7 @@ in home.sessionVariables = mkOption { default = {}; type = types.attrs; + example = { EDITOR = "emacs"; GS_OPTIONS = "-sPAPERSIZE=a4"; }; description = "Environment variables to always set at login."; }; diff --git a/modules/programs/bash.nix b/modules/programs/bash.nix index f17b3f1bd..a2000274c 100644 --- a/modules/programs/bash.nix +++ b/modules/programs/bash.nix @@ -38,6 +38,7 @@ in historyIgnore = mkOption { type = types.listOf types.str; default = []; + example = [ "ls" "cd" "exit" ]; description = "List of commands that should not be saved to the history list."; }; diff --git a/modules/programs/beets.nix b/modules/programs/beets.nix index 46a17a971..df9495ef2 100644 --- a/modules/programs/beets.nix +++ b/modules/programs/beets.nix @@ -14,7 +14,10 @@ in settings = mkOption { type = types.attrs; default = {}; - description = "Configuration written to ~/.config/beets/config.yaml"; + description = '' + Configuration written to + ~/.config/beets/config.yaml + ''; }; }; }; diff --git a/modules/programs/git.nix b/modules/programs/git.nix index 33fcbe428..672bd7997 100644 --- a/modules/programs/git.nix +++ b/modules/programs/git.nix @@ -26,7 +26,7 @@ let gpgPath = mkOption { type = types.str; default = "${pkgs.gnupg}/bin/gpg2"; - defaultText = "''${pkgs.gnupg}/bin/gpg2"; + defaultText = "\${pkgs.gnupg}/bin/gpg2"; description = "Path to GnuPG binary to use."; }; }; diff --git a/modules/programs/gnome-terminal.nix b/modules/programs/gnome-terminal.nix index cc34bdbb7..4a7646f24 100644 --- a/modules/programs/gnome-terminal.nix +++ b/modules/programs/gnome-terminal.nix @@ -169,6 +169,7 @@ in profile = mkOption { default = {}; type = types.loaOf profileSubModule; + description = "A set of Gnome Terminal profiles."; }; }; }; diff --git a/modules/xresources.nix b/modules/xresources.nix index 61efd3d98..abeed0c1f 100644 --- a/modules/xresources.nix +++ b/modules/xresources.nix @@ -21,15 +21,14 @@ in xresources.properties = mkOption { type = types.nullOr types.attrs; default = null; - example = '' - { - "XTerm*faceName" = "dejavu sans mono"; - "Emacs*toolBar" = 0; - } - ''; + example = { + "XTerm*faceName" = "dejavu sans mono"; + "Emacs*toolBar" = 0; + }; description = '' - X server resources that should be set. If null, then this - feature is disabled and no ~/.Xresources link is produced. + X server resources that should be set. If null, + then this feature is disabled and no + ~/.Xresources link is produced. ''; }; };