diff options
| author | Matt Mayer <[email protected]> | 2023-03-05 03:48:49 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-03-04 21:48:49 +0100 |
| commit | 859292878b55c572e5b841e67aee5e9da660989e (patch) | |
| tree | 05abad59baac09f256452f53d59a1b3b406df75b /docs | |
| parent | 8a97cac30f94bf7c29bfd6ffbad6ebf9c05fa2b1 (diff) | |
| download | faker-859292878b55c572e5b841e67aee5e9da660989e.tar.xz faker-859292878b55c572e5b841e67aee5e9da660989e.zip | |
docs: show deprecation message (#1889)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/.vitepress/components/api-docs/method.ts | 2 | ||||
| -rw-r--r-- | docs/.vitepress/components/api-docs/method.vue | 1 |
2 files changed, 2 insertions, 1 deletions
diff --git a/docs/.vitepress/components/api-docs/method.ts b/docs/.vitepress/components/api-docs/method.ts index 52cb2495..562d1ecf 100644 --- a/docs/.vitepress/components/api-docs/method.ts +++ b/docs/.vitepress/components/api-docs/method.ts @@ -5,7 +5,7 @@ export interface Method { readonly parameters: MethodParameter[]; readonly returns: string; readonly examples: string; // HTML - readonly deprecated: boolean; + readonly deprecated?: string; // HTML readonly since: string; readonly sourcePath: string; // URL-Suffix readonly seeAlsos: string[]; diff --git a/docs/.vitepress/components/api-docs/method.vue b/docs/.vitepress/components/api-docs/method.vue index 8bff111f..6753cefd 100644 --- a/docs/.vitepress/components/api-docs/method.vue +++ b/docs/.vitepress/components/api-docs/method.vue @@ -17,6 +17,7 @@ function seeAlsoToUrl(see: string): string { <div v-if="props.method.deprecated" class="warning custom-block"> <p class="custom-block-title">Deprecated</p> <p>This method is deprecated and will be removed in a future version.</p> + <span v-html="props.method.deprecated" /> </div> <div v-html="props.method.description"></div> |