Skip to content
Sarj Sarj Sarj Standards

no-typed-doc-sections

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

typedSection Rule source Tests Catalog JSON

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.

Examples

Before — flagged Do not expand a typed parameter's name
src/client.ts
/** @param userId the user identifier */
export function fetchValue(userId: string): number {
  return 1;
}
After — preferred Keep behavior that the signature cannot express
src/client.ts
/** Retries when the vendor returns 429. */
export function fetchValue(id: string): number {
  return 1;
}