Skip to content
Sarj Standards

TypeScript · maintainability

no-typed-doc-sections

eslint:no-typed-doc-sections

Reject typed-signature repetition while preserving behavior that types cannot express.

Default
error
Fix
none
Languages
typescript

Why

Parameter and return tags repeat typed signatures and can drift without adding runtime behavior or constraints.

Fix

Remove repeated parameter and return tags; retain documentation for behavior, failures, and external contracts.

Before / after

Executed by this rule’s unit tests.

Before

Do not restate typed parameters and returns

src/client.ts · focus
/** @param id external identifier
 * @returns the value
 */
export function fetchValue(id: string): number { return 1; }

After

Keep behavior that the signature cannot express

src/client.ts · focus
/** Retries when the vendor returns 429. */
export function fetchValue(id: string): number { return 1; }

Limits

  • Parameter and return tags are reported only when the documented function has corresponding explicit TypeScript types.

Message IDs

typedSection