Format Python, TypeScript, and JavaScript docstrings for clarity and consistency.
npx skills add https://github.com/jzallen/dashboard-chat --skill docstrings-jzallen
Please help me install this Agent Skill. Skill: docstrings Source: https://github.com/jzallen/dashboard-chat/tree/main/.claude/skills/docstrings Command: npx skills add https://github.com/jzallen/dashboard-chat --skill docstrings-jzallen
This Skill provides guidelines and best practices for writing clear and concise code documentation, helping developers maintain consistent standards and improve code readability.
Use the docstrings skill to format the docstrings of your Python function to ensure clarity and consistency.
High-intent search queries and answers about installing and using this skill.
Docstrings provide structured documentation for modules, classes, and functions to explain behavior, while inline comments describe specific code logic to improve readability and maintainability.
To write effective Python docstrings, follow formatting best practices that focus on clear, concise communication, avoiding unnecessary commentary and process trails to maintain code readability.
Yes, code documentation guidelines include specific formatting rules for TypeScript and JavaScript docstrings to ensure consistency and maintainability across your software project.
The best way to maintain consistent code documentation is to apply software best practices for code prose, avoiding process trails and ensuring comments remain clear and concise.
You should avoid writing inline comments when they create unnecessary commentary or process trails, as this degrades code readability and contradicts maintainability best practices.
convectiveFind code patterns by matching Abstract Syntax Tree structures via ast-grep CLI.
hnabyz-botGenerate API references and user manuals from source code using Sphinx, MkDocs, TypeDoc, or Docusaurus.
0xtaoistGenerate linting, formatting, and static analysis configs for TypeScript, Python, and .NET.
VYRE-StudiosGenerate READMEs, API references, and architecture docs from source code.
