Skip to content

Commit 16203e7

Browse files
authored
Merge pull request #787 from processing/fix/deprecation-message
Handle change to deprecation message format
2 parents a05d99e + f587157 commit 16203e7

2 files changed

Lines changed: 3 additions & 1 deletion

File tree

src/scripts/builders/reference.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,7 @@ const convertDocsToMDX = async (
415415
doc.example = correctRelativeLinksToExampleAssets(
416416
doc.example,
417417
) as string[];
418+
doc.deprecated = (doc.deprecated ? (doc.deprecationMessage ?? true) : undefined) as any;
418419
const mdx = await convertToMDX(doc);
419420

420421
return mdx ? { mdx, savePath, name: doc.name } : null;

types/parsers.interface.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,8 @@ interface Chainable {
9393
}
9494

9595
interface Deprecatable {
96-
deprecated?: string; // If this item is deprecated, a description of why.
96+
deprecated?: boolean; // If this item is deprecated, a description of why.
97+
deprecationMessage?: string; // If this item is deprecated, a description of why.
9798
}
9899

99100
/* Represents the return value of a method or constructor */

0 commit comments

Comments
 (0)