Skip to content

Commit

Permalink
lib.mdDoc: remove and replace with warning
Browse files Browse the repository at this point in the history
  • Loading branch information
stuebinm authored and wegank committed Apr 13, 2024
1 parent 1b28414 commit 0512637
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions lib/options.nix
Original file line number Diff line number Diff line change
Expand Up @@ -400,9 +400,11 @@ rec {
literalExample = lib.warn "lib.literalExample is deprecated, use lib.literalExpression instead, or use lib.literalMD for a non-Nix description." literalExpression;

/* Transition marker for documentation that's already migrated to markdown
syntax. This is a no-op and no longer needed.
syntax. Has been a no-op for some while and been removed from nixpkgs.
Kept here to alert downstream users who may not be aware of the migration's
completion that it should be removed from modules.
*/
mdDoc = lib.id;
mdDoc = lib.warn "lib.mdDoc was removed from nixpkgs. Option descriptions are now in Markdown by default, you can remove any remaining uses of it.";

/* For use in the `defaultText` and `example` option attributes. Causes the
given MD text to be inserted verbatim in the documentation, for when
Expand Down
2 changes: 1 addition & 1 deletion nixos/modules/services/networking/mtr-exporter.nix
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ let
inherit (lib)
maintainers types literalExpression
escapeShellArg escapeShellArgs
mkEnableOption mkOption mkRemovedOptionModule mkIf
mkEnableOption mkOption mkRemovedOptionModule mkIf
mkPackageOption optionalString concatMapStrings concatStringsSep;

cfg = config.services.mtr-exporter;
Expand Down

0 comments on commit 0512637

Please sign in to comment.