Skip to content

Commit

Permalink
maint: Remove mdDoc call
Browse files Browse the repository at this point in the history
It has been removed upstream in Nixpkgs.
This fixes documentation rendering with the latest Nixpkgs.
  • Loading branch information
roberth authored and srid committed Dec 4, 2024
1 parent 781a209 commit ee451c1
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions nix/flake-module.nix
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ in
options = {
description = mkOption {
type = types.nullOr types.str;
description = lib.mdDoc ''
description = ''
A description of what this script does.
This will be displayed in the banner and help menu.
Expand All @@ -24,14 +24,14 @@ in
};
category = mkOption {
type = types.str;
description = lib.mdDoc ''
description = ''
The category under which this script will be gropuped.
'';
default = "Commands";
};
exec = mkOption {
type = types.oneOf [ types.str types.package ];
description = lib.mdDoc ''
description = ''
The script or package to run
The $FLAKE_ROOT environment variable will be set to the
Expand All @@ -41,7 +41,7 @@ in
};
cdToProjectRoot = mkOption {
type = types.bool;
description = lib.mdDoc ''
description = ''
Whether to change the working directory to the project root
before running the script.
'';
Expand All @@ -54,21 +54,21 @@ in
options = {
wrapperName = mkOption {
type = types.str;
description = lib.mdDoc ''
description = ''
The name of the wrapper script
'';
default = ",";
};
scripts = mkOption {
type = types.attrsOf scriptSubmodule;
description = lib.mdDoc ''
description = ''
List of scripts to be added to the shell
'';
default = { };
};
wrapper = mkOption {
type = types.package;
description = lib.mdDoc ''
description = ''
The generated wrapper script.
'';
default = import ./wrapper.nix {
Expand All @@ -79,15 +79,15 @@ in
};
banner = mkOption {
type = types.str;
description = lib.mdDoc ''
description = ''
The generated shell banner.
'';
default = import ./banner.nix { inherit (config) wrapper wrapperName; };
defaultText = lib.literalMD "generated package";
};
devShell = mkOption {
type = types.package;
description = lib.mdDoc ''
description = ''
A devShell containing the banner and wrapper.
'';
readOnly = true;
Expand All @@ -104,7 +104,7 @@ in
{
options.mission-control = lib.mkOption {
type = mainSubmodule;
description = lib.mdDoc ''
description = ''
Specification for the scripts in dev shell
'';
default = { };
Expand Down

0 comments on commit ee451c1

Please sign in to comment.