Remove redundant type information from comments in TypeScript documentation.
npx skills add https://github.com/luyi985/lyi-bash --skill no-type-in-docs
Please help me install this Agent Skill. Skill: no-type-in-docs Source: https://github.com/luyi985/lyi-bash/tree/main/ai/skills/no-type-in-docs Command: npx skills add https://github.com/luyi985/lyi-bash --skill no-type-in-docs
Comments describing types drift out of sync with code. TypeScript's type system is designed to be compact and readable - use it as your primary source of type documentation.
Refactor a sample function to remove type details from comments and ensure the function's behavior is explained without duplicating types.
High-intent search queries and answers about installing and using this skill.
Yes, you should remove type details from inline documentation for TypeScript functions. Prioritize explaining the function's behavior and rationale instead of repeating parameter and return value types.
Comments describing types drift out of sync with code because types are duplicated in documentation. TypeScript's compact type system should be the primary source of type documentation to prevent this drift.
To document readonly parameters in TypeScript functions, use readonly modifiers for non-mutation semantics and let the type annotation speak for itself, focusing the comment on the parameter's purpose.
The best way to write intent-focused comments for typed languages is to eliminate redundant type information and explain the why and how of the code, ensuring frontend and backend projects remain maintainable.
Yes, you can apply this documentation principle to both frontend and backend TypeScript projects. It enforces not duplicating types in comments across all functions, parameters, and return values.
xloxn69Generate TypeScript interfaces, types, enums, and generics from data structure descriptions.
mostafa-ismail-2004Writes rationale-focused code comments explaining intent, constraints, and non-obvious decisions.
TheBushidoCollectiveApply TypeScript utility types to resolve type-safety gaps in code.
23blocks-OSSearch project documentation for function signatures and API details before implementing code.
