docstring-patterns

Writing effective Python docstrings requires following language-specific conventions and universal best practices to ensure code clarity. This Skill provides guidance on syntax standards, common patterns, and anti-patterns to improve developer onboarding and maintainability across your codebase.

TypeScript documentation comment standards involve specific syntax conventions for documenting complex scenarios like overloaded functions. This Skill provides a pattern library covering TypeScript/JavaScript standards, ensuring your code comments remain clear, concise, and informative for other developers.

Yes, this docstring guidance covers Rust and Go code comment conventions alongside TypeScript and Python. It explains the unique syntax and standards for each language, helping you apply the correct documentation format and maintain consistency across multi-language projects.

Documenting overloaded functions and builder patterns requires applying specific docstring patterns designed for complex code structures. This Skill offers a pattern library that demonstrates how to clearly document these advanced scenarios while avoiding common documentation anti-patterns.

Inconsistent code comments cause developer onboarding problems by reducing code clarity and increasing the time needed to understand project logic. Applying standardized docstring conventions and universal best practices ensures your codebase remains maintainable and accessible to new contributors.