aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2024-06-19 22:20:28 +0200
committerGitHub <[email protected]>2024-06-19 22:20:28 +0200
commitd9ce8d2da92f1df0f35e29248dc8176fd59e2116 (patch)
tree3a91c1ed15d1bdf2b0c87be0698a3533a1fe67f4
parent80d5aad652d051f6a355f9f065a5d946b7d03d3e (diff)
downloadfaker-d9ce8d2da92f1df0f35e29248dc8176fd59e2116.tar.xz
faker-d9ce8d2da92f1df0f35e29248dc8176fd59e2116.zip
chore: replace obsolete mentions of typedoc (#2957)
-rw-r--r--.gitignore1
-rw-r--r--scripts/apidocs/utils/format.ts4
-rw-r--r--tsconfig.json2
3 files changed, 3 insertions, 4 deletions
diff --git a/.gitignore b/.gitignore
index d50069ba..2d3321a3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -77,7 +77,6 @@ versions.json
/dist
/docs/.vitepress/cache
/docs/.vitepress/dist
-/docs/api/typedoc.json
/docs/public/api-diff-index.json
/lib
diff --git a/scripts/apidocs/utils/format.ts b/scripts/apidocs/utils/format.ts
index ab9f524d..c6c07ee6 100644
--- a/scripts/apidocs/utils/format.ts
+++ b/scripts/apidocs/utils/format.ts
@@ -3,7 +3,7 @@ import { format } from 'prettier';
import prettierConfig from '../../../.prettierrc.js';
/**
- * Formats markdown contents.
+ * Formats Markdown contents.
*
* @param text The text to format.
*/
@@ -12,7 +12,7 @@ export async function formatMarkdown(text: string): Promise<string> {
}
/**
- * Formats typedoc contents.
+ * Formats TypeScript contents.
*
* @param text The text to format.
*/
diff --git a/tsconfig.json b/tsconfig.json
index 6d3b09b3..cc4809da 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -17,7 +17,7 @@
"exclude": [
"node_modules",
"dist",
- // required for the typedoc related tests on macOS #2280
+ // required for the signature related tests on macOS #2280
"test/scripts/apidocs/temp"
]
}