Merge pull request #304277 from eclairevoyant/mddoc-fix
lib: add mdDoc back in to provide proper warning; set explicit timeline for removal
This commit is contained in:
+1
-1
@@ -146,7 +146,7 @@ let
|
||||
scrubOptionValue literalExpression literalExample
|
||||
showOption showOptionWithDefLocs showFiles
|
||||
unknownModule mkOption mkPackageOption mkPackageOptionMD
|
||||
literalMD;
|
||||
mdDoc literalMD;
|
||||
inherit (self.types) isType setType defaultTypeMerge defaultFunctor
|
||||
isOptionType mkOptionType;
|
||||
inherit (self.asserts)
|
||||
|
||||
+1
-1
@@ -404,7 +404,7 @@ rec {
|
||||
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.warn "lib.mdDoc was removed from nixpkgs. Option descriptions are now in Markdown by default, you can remove any remaining uses of it.";
|
||||
mdDoc = lib.warn "lib.mdDoc will be removed from nixpkgs in 24.11. Option descriptions are now in Markdown by default; you can remove any remaining uses of lib.mdDoc.";
|
||||
|
||||
/* For use in the `defaultText` and `example` option attributes. Causes the
|
||||
given MD text to be inserted verbatim in the documentation, for when
|
||||
|
||||
Reference in New Issue
Block a user