Skip to content

Commit 0d3019a

Browse files
committed
Trim JSDoc comment on BlockTool.sanitize
Remove prose paragraph and opinionated "recommended" annotation, keeping the @example blocks that clearly demonstrate both usage modes.
1 parent 0e8f20d commit 0d3019a

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

types/tools/block-tool.d.ts

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,10 @@ export interface BlockTool extends BaseTool {
1515
/**
1616
* Sanitizer rules description.
1717
*
18-
* Can be a flat SanitizerConfig (tag-level rules applied to all output)
19-
* or a Record mapping data field names to their individual SanitizerConfig.
20-
*
21-
* @example Flat (tag-level) config
18+
* @example Flat config (tag-level rules applied to all output)
2219
* { b: true, a: { href: true } }
2320
*
24-
* @example Per-field config (recommended for tools with structured data)
21+
* @example Per-field config
2522
* { text: { br: true, b: true }, caption: { b: true, i: true } }
2623
*/
2724
sanitize?: SanitizerConfig | Record<string, SanitizerConfig>;

0 commit comments

Comments
 (0)