Skip to content

Commit

Permalink
chore: remove lib.mdDoc
Browse files Browse the repository at this point in the history
lib.mdDoc was removed from nixpkgs NixOS/nixpkgs#237557
  • Loading branch information
anpin committed Dec 2, 2024
1 parent b31b1bc commit 17fc663
Show file tree
Hide file tree
Showing 16 changed files with 51 additions and 51 deletions.
2 changes: 1 addition & 1 deletion modules/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ in {
type = types.functionTo (types.listOf types.package);
default = ps: [];
example = ps: [ps.jupytext];
description = lib.mdDoc "A list of packages for extending the jupyterlab environment";
description = "A list of packages for extending the jupyterlab environment";
};
}
// (
Expand Down
12 changes: 6 additions & 6 deletions modules/kernel.nix
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ in {
type = types.bool;
default = false;
example = true;
description = lib.mdDoc ''
description = ''
Enable ${kernelName} kernel.
'';
};
Expand All @@ -23,7 +23,7 @@ in {
type = types.str;
default = "${kernelName}-${name}";
example = "${kernelName}-example";
description = lib.mdDoc ''
description = ''
Name of the ${kernelName} kernel.
'';
};
Expand All @@ -32,7 +32,7 @@ in {
type = types.str;
default = "${config.name} kernel";
example = "${kernelName} example kernel";
description = lib.mdDoc ''
description = ''
Display name of the ${kernelName} kernel.
'';
};
Expand All @@ -41,15 +41,15 @@ in {
type = types.listOf types.package;
default = requiredRuntimePackages;
example = lib.literalExpression "[pkgs.example]";
description = lib.mdDoc ''
description = ''
A list of required runtime packages for this ${kernelName} kernel.
'';
};

runtimePackages = lib.mkOption {
type = types.listOf types.package;
default = [];
description = lib.mdDoc ''
description = ''
A list of user desired runtime packages for this ${kernelName} kernel.
'';
};
Expand All @@ -72,7 +72,7 @@ in {
};
};
type = types.attrs;
description = lib.mdDoc ''
description = ''
Extra kernel spec attributes.
'';
};
Expand Down
4 changes: 2 additions & 2 deletions modules/kernels/dotnet/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
language = lib.mkOption {
type = lib.types.enum ["csharp" "fsharp"];
default = "csharp";
description = lib.mdDoc ''
description = ''
Language flavour of dotnet-interactive kernel
'';
};
Expand All @@ -80,7 +80,7 @@ in {
kernel.${kernelName}."example".enable = true;
}
'';
description = lib.mdDoc ''
description = ''
A ${kernelName} kernel for IPython.
'';
};
Expand Down
2 changes: 1 addition & 1 deletion modules/kernels/go/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ in {
kernel.${kernelName}."example".enable = true;
}
'';
description = lib.mdDoc ''
description = ''
A ${kernelName} kernel for IPython.
'';
};
Expand Down
10 changes: 5 additions & 5 deletions modules/kernels/haskell/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
default = self.inputs.ihaskell;
defaultText = lib.literalExpression "self.inputs.ihaskell";
example = lib.literalExpression "self.inputs.ihaskell";
description = lib.mdDoc ''
description = ''
ihaskell flake input to be used for this ${kernelName} kernel.
'';
};
Expand All @@ -74,7 +74,7 @@
type = types.str;
default = "ghc910";
example = "ghc910";
description = lib.mdDoc ''
description = ''
haskell compiler
'';
};
Expand All @@ -83,7 +83,7 @@
type = types.str;
default = "-M3g -N2";
example = "-M3g -N2";
description = lib.mdDoc ''
description = ''
haskell compiler flags
'';
};
Expand All @@ -93,7 +93,7 @@
default = _: [];
defaultText = lib.literalExpression "ps: []";
example = lib.literalExpression "ps: [ps.lens ps.vector]";
description = lib.mdDoc ''
description = ''
extra haskell packages
'';
};
Expand Down Expand Up @@ -162,7 +162,7 @@ in {
kernel.${kernelName}."example".enable = true;
}
'';
description = lib.mdDoc ''
description = ''
A ${kernelName} kernel for IPython.
'';
};
Expand Down
2 changes: 1 addition & 1 deletion modules/kernels/javascript/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ in {
kernel.${kernelName}."example".enable = true;
}
'';
description = lib.mdDoc ''
description = ''
A ${kernelName} kernel for IPython.
'';
};
Expand Down
10 changes: 5 additions & 5 deletions modules/kernels/julia/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -75,28 +75,28 @@
ijuliaRev = lib.mkOption {
type = types.str;
default = "bHdNn";
description = lib.mdDoc ''
description = ''
IJulia revision
'';
};
julia = lib.mkOption {
type = types.package;
default = config.nixpkgs.julia_19;
description = lib.mdDoc ''
description = ''
Julia Version
'';
};
extraJuliaPackages = lib.mkOption {
type = types.listOf types.str;
default = [];
description = lib.mdDoc ''
description = ''
Extra Julia packages to install
'';
};
override = lib.mkOption {
type = types.attrs;
default = {};
description = lib.mdDoc ''
description = ''
Override JuliaWithPackages
'';
};
Expand All @@ -121,7 +121,7 @@ in {
kernel.${kernelName}."example".enable = true;
}
'';
description = lib.mdDoc ''
description = ''
A ${kernelName} kernel for IPython.
'';
};
Expand Down
4 changes: 2 additions & 2 deletions modules/kernels/nix/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
nix = lib.mkOption {
type = types.package;
default = config.nixpkgs.nix;
description = lib.mdDoc ''
description = ''
Nix Version
'';
};
Expand All @@ -96,7 +96,7 @@ in {
kernel.${kernelName}."example".enable = true;
}
'';
description = lib.mdDoc ''
description = ''
A ${kernelName} kernel for IPython.
'';
};
Expand Down
8 changes: 4 additions & 4 deletions modules/kernels/ocaml/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
default = self.inputs.opam-nix;
defaultText = lib.literalExpression "self.inputs.opam-nix";
example = lib.literalExpression ''builtins.getFlake "github:tweag/opam-nix"'';
description = lib.mdDoc ''
description = ''
opam-nix flake input to be used for this ${kernelName} kernel.
'';
};
Expand All @@ -134,7 +134,7 @@
type = types.attrs;
default = {merlin = "*";};
example = {merlin = "4.7.1-500";};
description = lib.mdDoc ''
description = ''
Attribute set of required OCaml packages.
'';
};
Expand All @@ -148,7 +148,7 @@

my-custom-package = "dev";
};
description = lib.mdDoc ''
description = ''
Attribute set of user desired OCaml packages.
If you wish to add custom packages (not from opam-repository), see also the `opamProjects` option.
Expand Down Expand Up @@ -205,7 +205,7 @@ in {
kernel.${kernelName}."example".enable = true;
}
'';
description = lib.mdDoc ''
description = ''
A ${kernelName} kernel for IPython.
'';
};
Expand Down
8 changes: 4 additions & 4 deletions modules/kernels/r/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
type = types.package;
default = config.nixpkgs.rWrapper;
defaultText = lib.literalExpression "pkgs.rWrapper";
description = lib.mdDoc ''
description = ''
R version from nixpkgs.
'';
};
Expand All @@ -80,7 +80,7 @@
type = types.attrs;
default = config.nixpkgs.rPackages;
defaultText = lib.literalExpression "pkgs.rPackages";
description = lib.mdDoc ''
description = ''
A set of R packages.
'';
};
Expand All @@ -90,7 +90,7 @@
default = _: [];
defaultText = lib.literalExpression "_: []";
example = lib.literalExpression "ps: [ps.foreign ps.ggplot2]";
description = lib.mdDoc ''
description = ''
Extra R packages.
'';
};
Expand All @@ -115,7 +115,7 @@ in {
kernel.${kernelName}."example".enable = true;
}
'';
description = lib.mdDoc ''
description = ''
A ${kernelName} kernel for IPython.
'';
};
Expand Down
6 changes: 3 additions & 3 deletions modules/kernels/rust/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
type = types.package;
default = config.nixpkgs.evcxr;
example = lib.literalExpression "pkgs.evcxr";
description = lib.mdDoc ''
description = ''
An evaluation context for Rust.
'';
};
Expand All @@ -91,7 +91,7 @@
default = self.inputs.rust-overlay;
defaultText = lib.literalExpression "self.inputs.rust-overlay";
example = lib.literalExpression "self.inputs.rust-overlay";
description = lib.mdDoc ''
description = ''
An overlay for binary distributed rust toolchains. Adds `rust-bin` to nixpkgs which is needed for the Rust kernel.
'';
};
Expand Down Expand Up @@ -119,7 +119,7 @@ in {
kernel.${kernelName}."example".enable = true;
}
'';
description = lib.mdDoc ''
description = ''
A ${kernelName} kernel for IPython.
'';
};
Expand Down
10 changes: 5 additions & 5 deletions modules/kernels/scala/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@
type = types.package;
default = config.nixpkgs.scala_2_12;
example = lib.literalExpression "pkgs.scala";
description = lib.mdDoc ''
description = ''
Scala package to use with almond.
'';
};
Expand All @@ -125,7 +125,7 @@
type = types.package;
default = config.nixpkgs.coursier;
example = lib.literalExpression "pkgs.coursier";
description = lib.mdDoc ''
description = ''
Coursier package to use with almond.
'';
};
Expand All @@ -134,7 +134,7 @@
type = types.package;
default = config.nixpkgs.jdk;
example = lib.literalExpression "pkgs.jdk";
description = lib.mdDoc ''
description = ''
JDK package to use with almond.
'';
};
Expand All @@ -143,7 +143,7 @@
type = types.package;
default = config.nixpkgs.jre;
example = lib.literalExpression "pkgs.jre";
description = lib.mdDoc ''
description = ''
JRE package to use with almond.
'';
};
Expand All @@ -167,7 +167,7 @@ in {
kernel.${kernelName}."example".enable = true;
}
'';
description = lib.mdDoc ''
description = ''
A ${kernelName} kernel for IPython.
'';
};
Expand Down
4 changes: 2 additions & 2 deletions modules/kernels/typescript/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@
default = self.inputs.npmlock2nix;
defaultText = lib.literalExpression "self.inputs.npmlock2nix";
example = lib.literalExpression "self.inputs.npmlock2nix";
description = lib.mdDoc ''
description = ''
npmlock2nix flake input to be used to build this ${kernelName} kernel.
'';
};
Expand All @@ -165,7 +165,7 @@ in {
kernel.${kernelName}."example".enable = true;
}
'';
description = lib.mdDoc ''
description = ''
A ${kernelName} kernel for IPython.
'';
};
Expand Down
2 changes: 1 addition & 1 deletion modules/poetry.nix
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ in {
kernel.${kernelName}."example".enable = true;
}
'';
description = lib.mdDoc ''
description = ''
A ${kernelName} kernel for IPython.
'';
};
Expand Down
2 changes: 1 addition & 1 deletion modules/types/nixpkgs.nix
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ in
else applyOverlays self.inputs.nixpkgs;
defaultText = lib.literalExpression "self.inputs.nixpkgs";
example = lib.literalExpression "self.inputs.nixpkgs";
description = lib.mdDoc ''
description = ''
nixpkgs flake input to be used for jupyenv
'';
apply = x: nixpkgsArg x;
Expand Down
Loading

0 comments on commit 17fc663

Please sign in to comment.