aboutsummaryrefslogtreecommitdiff
path: root/docs/.vitepress/components/api-docs/method.ts
diff options
context:
space:
mode:
authorShinigami <[email protected]>2025-06-17 21:30:05 +0200
committerGitHub <[email protected]>2025-06-17 21:30:05 +0200
commit04e8b7bab82069bf60961580e353e36096bc2120 (patch)
treec2889fd024c7d30e9af1211f2ae7736e28215e8a /docs/.vitepress/components/api-docs/method.ts
parent1726ded4e61e9f7ce7b76a1759da820270a7a316 (diff)
downloadfaker-04e8b7bab82069bf60961580e353e36096bc2120.tar.xz
faker-04e8b7bab82069bf60961580e353e36096bc2120.zip
docs: add remarks about external sources (#3452)
Diffstat (limited to 'docs/.vitepress/components/api-docs/method.ts')
-rw-r--r--docs/.vitepress/components/api-docs/method.ts3
1 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 91f99d4e..9ae154ca 100644
--- a/docs/.vitepress/components/api-docs/method.ts
+++ b/docs/.vitepress/components/api-docs/method.ts
@@ -2,6 +2,7 @@ export interface ApiDocsMethod {
readonly name: string;
readonly deprecated: string | undefined; // HTML
readonly description: string; // HTML
+ readonly remark: string | undefined; // HTML
readonly since: string;
readonly parameters: ApiDocsMethodParameter[];
readonly returns: string;
@@ -9,7 +10,7 @@ export interface ApiDocsMethod {
readonly signature: string; // HTML
readonly examples: string; // HTML
readonly refresh: (() => Promise<unknown[]>) | undefined;
- readonly seeAlsos: string[];
+ readonly seeAlsos: string[]; // HTML
readonly sourcePath: string; // URL-Suffix
}