no-type-in-docs
CommunityLet types speak; avoid duplicating type info.
Authorluyi985
Version1.0.0
Installs0
System Documentation
What problem does it solve?
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.
Core Features & Use Cases
- Enforces that type information is not repeated in comments and documentation.
- Guides developers to write comments that explain intent, rationale, and behavior rather than types.
- Applicable to TypeScript and other typed languages when documenting functions, parameters, and return values in both frontend and backend codebases.
Quick Start
Refactor a sample function to remove type details from comments and ensure the function's behavior is explained without duplicating types.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: no-type-in-docs Download link: https://github.com/luyi985/lyi-bash/archive/main.zip#no-type-in-docs Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.