update-docstrings

Writes and updates docstrings and inline comments in Python, TypeScript, and Rust source files.

9|Updated Jul 17, 2026
One-click install
npx skills add https://github.com/Yassimba/loom --skill update-docstrings-yassimba
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docstrings
Source: https://github.com/Yassimba/loom/tree/main/skills/update-docstrings
Command: npx skills add https://github.com/Yassimba/loom --skill update-docstrings-yassimba

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Source code often ships with missing, stale, or process-laden docstrings and comments that confuse first-time readers. This Skill rewrites every docstring and comment to be self-contained, forward-facing, and consistent with the language's documentation dialect, without ever touching the code itself. ## Core Features & Use Cases - Docs-only diffs: Adds or fixes docstrings and comments while guaranteeing no code changes — signatures, imports, and logic stay untouched. - Language dialects: Applies NumPy style for Python, TSDoc for TypeScript/JavaScript, and rustdoc for Rust, with per-language public/internal rules and linter commands (ruff, eslint-plugin-jsdoc, cargo doc). - Comment triage: Deletes commented-out code, restatements, and decorative banners, and rewrites surviving comments to explain why rather than what. - Use Case: A team adopts a new Python codebase with undocumented modules. Run this Skill to give every public function a full NumPy-style docstring, trim internal helpers to one line, and clean the comment noise, then verify with ruff check --select D. ## Quick Start Use the update-docstrings skill to add NumPy-style docstrings to every function in src/parser.py and clean up its comments.

Frequently Asked Questions about update-docstrings

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add docstrings to an entire Python file?

Read the file end-to-end, mark public versus internal symbols, then write NumPy-style docstrings in source order — full sections for public API, one line for internal helpers. Finish by running ruff check --select D with the numpy convention to catch gaps.

What docstring style should I use for Python, TypeScript, or Rust?

Python uses NumPy style with Parameters, Returns, Raises, and doctest Examples sections. TypeScript uses TSDoc with @param, @returns, and @throws tags. Rust uses rustdoc with # Errors, # Panics, and # Safety sections instead of parameter tables.

Does updating docstrings change any of my code?

No. The diff touches only docstrings and comments — never signatures, imports, or logic. If a real fix requires a code change like a rename or extraction, it is proposed to the user rather than applied silently.

Should private or internal functions get docstrings too?

Yes, presence never lapses, but length scales down. Internal symbols get one sentence, plus at most one more on how they work when non-obvious — no parameter or return sections, which would just restate the signature.

Which comments should be deleted during a comment cleanup?

Delete commented-out code, comments that restate the line below them, decorative banners and dividers, and vague doubts or notes-to-self. Keep only comments that explain why — non-obvious decisions, workarounds, or invariants — rewritten as forward-facing prose.