Open Bug 1953123 Opened 7 days ago Updated 7 days ago

Investigate implementing a lint rule to require JSDoc returns information only when the type can't be inferred by TypeScript

Categories

(Developer Infrastructure :: Lint and Formatting, task, P3)

Tracking

(Not tracked)

People

(Reporter: standard8, Unassigned)

References

Details

As per the discussion on bug 1913855, we're currently dropping the ESLint rule jsdoc/require-returns, because this can sometimes cause extra duplication when using TypeScript.

Ideally, what we'd like is some sort of rule (not necessarily ESLint based), that would require @returns documentation when the type can't be inferred by TypeScript.

Summary: Investigate implementing a lint rule to require JSDoc o returns only when the type can't be inferred by TypeScript → Investigate implementing a lint rule to require JSDoc returns information only when the type can't be inferred by TypeScript
You need to log in before you can comment on or make changes to this bug.