diff options
author | Naïm Favier <n@monade.li> | 2021-10-03 18:06:03 +0200 |
---|---|---|
committer | Naïm Favier <n@monade.li> | 2021-10-04 12:47:20 +0200 |
commit | 2ddc335e6f32b875e14ad9610101325b306a0add (patch) | |
tree | 2a4591c137cb363a6ec09f529d587a10aa7a0bc7 /nixos/modules/services/development | |
parent | 330b1e08b8df4e1f0100a0a7810ec3157749e5ee (diff) | |
download | nixlib-2ddc335e6f32b875e14ad9610101325b306a0add.tar nixlib-2ddc335e6f32b875e14ad9610101325b306a0add.tar.gz nixlib-2ddc335e6f32b875e14ad9610101325b306a0add.tar.bz2 nixlib-2ddc335e6f32b875e14ad9610101325b306a0add.tar.lz nixlib-2ddc335e6f32b875e14ad9610101325b306a0add.tar.xz nixlib-2ddc335e6f32b875e14ad9610101325b306a0add.tar.zst nixlib-2ddc335e6f32b875e14ad9610101325b306a0add.zip |
nixos/doc: clean up defaults and examples
Diffstat (limited to 'nixos/modules/services/development')
6 files changed, 32 insertions, 23 deletions
diff --git a/nixos/modules/services/development/distccd.nix b/nixos/modules/services/development/distccd.nix index 8790ea08d0c1..9f6d5c813c45 100644 --- a/nixos/modules/services/development/distccd.nix +++ b/nixos/modules/services/development/distccd.nix @@ -69,7 +69,7 @@ in package = mkOption { type = types.package; default = pkgs.distcc; - example = "pkgs.distcc"; + defaultText = literalExpression "pkgs.distcc"; description = '' The distcc package to use. ''; diff --git a/nixos/modules/services/development/hoogle.nix b/nixos/modules/services/development/hoogle.nix index a6693013b73c..7c635f7a5b8d 100644 --- a/nixos/modules/services/development/hoogle.nix +++ b/nixos/modules/services/development/hoogle.nix @@ -27,8 +27,8 @@ in { packages = mkOption { type = types.functionTo (types.listOf types.package); default = hp: []; - defaultText = "hp: []"; - example = "hp: with hp; [ text lens ]"; + defaultText = literalExpression "hp: []"; + example = literalExpression "hp: with hp; [ text lens ]"; description = '' The Haskell packages to generate documentation for. @@ -41,7 +41,7 @@ in { haskellPackages = mkOption { description = "Which haskell package set to use."; default = pkgs.haskellPackages; - defaultText = "pkgs.haskellPackages"; + defaultText = literalExpression "pkgs.haskellPackages"; }; home = mkOption { diff --git a/nixos/modules/services/development/jupyter/default.nix b/nixos/modules/services/development/jupyter/default.nix index 21b84b3bcdaa..bebb3c3f13f0 100644 --- a/nixos/modules/services/development/jupyter/default.nix +++ b/nixos/modules/services/development/jupyter/default.nix @@ -40,6 +40,7 @@ in { # want to pass in JUPYTER_PATH but use .environment instead, # saving a rebuild. default = pkgs.python3.pkgs.notebook; + defaultText = literalExpression "pkgs.python3.pkgs.notebook"; description = '' Jupyter package to use. ''; @@ -105,10 +106,7 @@ in { "open('/path/secret_file', 'r', encoding='utf8').read().strip()" It will be interpreted at the end of the notebookConfig. ''; - example = [ - "'sha1:1b961dc713fb:88483270a63e57d18d43cf337e629539de1436ba'" - "open('/path/secret_file', 'r', encoding='utf8').read().strip()" - ]; + example = "'sha1:1b961dc713fb:88483270a63e57d18d43cf337e629539de1436ba'"; }; notebookConfig = mkOption { @@ -125,7 +123,7 @@ in { }))); default = null; - example = literalExample '' + example = literalExpression '' { python3 = let env = (pkgs.python3.withPackages (pythonPackages: with pythonPackages; [ diff --git a/nixos/modules/services/development/jupyter/kernel-options.nix b/nixos/modules/services/development/jupyter/kernel-options.nix index 03547637449a..348a8b44b382 100644 --- a/nixos/modules/services/development/jupyter/kernel-options.nix +++ b/nixos/modules/services/development/jupyter/kernel-options.nix @@ -9,10 +9,10 @@ with lib; displayName = mkOption { type = types.str; default = ""; - example = [ + example = literalExpression '' "Python 3" "Python 3 for Data Science" - ]; + ''; description = '' Name that will be shown to the user. ''; @@ -43,7 +43,7 @@ with lib; logo32 = mkOption { type = types.nullOr types.path; default = null; - example = "{env.sitePackages}/ipykernel/resources/logo-32x32.png"; + example = literalExpression ''"''${env.sitePackages}/ipykernel/resources/logo-32x32.png"''; description = '' Path to 32x32 logo png. ''; @@ -51,7 +51,7 @@ with lib; logo64 = mkOption { type = types.nullOr types.path; default = null; - example = "{env.sitePackages}/ipykernel/resources/logo-64x64.png"; + example = literalExpression ''"''${env.sitePackages}/ipykernel/resources/logo-64x64.png"''; description = '' Path to 64x64 logo png. ''; diff --git a/nixos/modules/services/development/jupyterhub/default.nix b/nixos/modules/services/development/jupyterhub/default.nix index a1df4468cfff..fa6b3be960ab 100644 --- a/nixos/modules/services/development/jupyterhub/default.nix +++ b/nixos/modules/services/development/jupyterhub/default.nix @@ -66,18 +66,24 @@ in { defaults for configuration but you can override anything since this is a python file. ''; - example = literalExample '' - c.SystemdSpawner.mem_limit = '8G' - c.SystemdSpawner.cpu_limit = 2.0 + example = '' + c.SystemdSpawner.mem_limit = '8G' + c.SystemdSpawner.cpu_limit = 2.0 ''; }; jupyterhubEnv = mkOption { type = types.package; - default = (pkgs.python3.withPackages (p: with p; [ + default = pkgs.python3.withPackages (p: with p; [ jupyterhub jupyterhub-systemdspawner - ])); + ]); + defaultText = literalExpression '' + pkgs.python3.withPackages (p: with p; [ + jupyterhub + jupyterhub-systemdspawner + ]) + ''; description = '' Python environment to run jupyterhub @@ -90,10 +96,16 @@ in { jupyterlabEnv = mkOption { type = types.package; - default = (pkgs.python3.withPackages (p: with p; [ + default = pkgs.python3.withPackages (p: with p; [ jupyterhub jupyterlab - ])); + ]); + defaultText = literalExpression '' + pkgs.python3.withPackages (p: with p; [ + jupyterhub + jupyterlab + ]) + ''; description = '' Python environment to run jupyterlab @@ -111,7 +123,7 @@ in { }))); default = null; - example = literalExample '' + example = literalExpression '' { python3 = let env = (pkgs.python3.withPackages (pythonPackages: with pythonPackages; [ diff --git a/nixos/modules/services/development/lorri.nix b/nixos/modules/services/development/lorri.nix index fc576e4c18ba..bda63518bfd9 100644 --- a/nixos/modules/services/development/lorri.nix +++ b/nixos/modules/services/development/lorri.nix @@ -21,8 +21,7 @@ in { description = '' The lorri package to use. ''; - defaultText = lib.literalExample "pkgs.lorri"; - example = lib.literalExample "pkgs.lorri"; + defaultText = lib.literalExpression "pkgs.lorri"; }; }; }; |