diff options
| author | ST-DDT <[email protected]> | 2024-06-21 11:41:03 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-06-21 11:41:03 +0200 |
| commit | 5801cc5cad8324a114d08733fafa31f7632d1118 (patch) | |
| tree | 7de3637ce93557f7862c0d7c5e4a64d26cf2efe1 /scripts | |
| parent | 909ea01a6cc9f4753aeba45ba9e7bd1726e68916 (diff) | |
| download | faker-5801cc5cad8324a114d08733fafa31f7632d1118.tar.xz faker-5801cc5cad8324a114d08733fafa31f7632d1118.zip | |
docs: separate signature and examples (#2962)
Diffstat (limited to 'scripts')
| -rw-r--r-- | scripts/apidocs/output/page.ts | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/scripts/apidocs/output/page.ts b/scripts/apidocs/output/page.ts index 9f3c87f7..c00ba4d2 100644 --- a/scripts/apidocs/output/page.ts +++ b/scripts/apidocs/output/page.ts @@ -165,7 +165,8 @@ async function toMethodData(method: RawApiDocsMethod): Promise<ApiDocsMethod> { sourcePath: `${filePath}#L${line}`, throws: throws.length === 0 ? undefined : mdToHtml(throws.join('\n'), true), returns: returns.text, - examples: codeToHtml([formattedSignature, ...examples].join('\n')), + signature: codeToHtml(formattedSignature), + examples: codeToHtml(examples.join('\n')), deprecated: mdToHtml(deprecated), seeAlsos: seeAlsos.map((seeAlso) => mdToHtml(seeAlso, true)), }; |