Skills
.Work. You
Rest

docstring-patterns

Community

Master code documentation standards.

Software Engineering#typescript#documentation#python#go#code comments#rust#docstrings
AuthorHermeticOrmus
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill provides comprehensive guidance on writing effective documentation comments (docstrings) for various programming languages, ensuring code clarity and maintainability.

Core Features & Use Cases

  • Best Practices: Learn universal principles for clear, concise, and informative docstrings.
  • Language-Specific Conventions: Understand the unique syntax and standards for TypeScript/JavaScript, Python, Rust, and Go.
  • Pattern Library: Discover common docstring patterns for complex scenarios like builder patterns and overloaded functions.
  • Use Case: A developer new to a project can use this Skill to quickly understand and apply the correct docstring format for their code contributions, ensuring consistency across the codebase.

Quick Start

Explain the best practices for writing Python docstrings.

Dependency Matrix

Required Modules

None required

Components

references

💻 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: docstring-patterns
Download link: https://github.com/HermeticOrmus/LibreCopy-Claude-Code/archive/main.zip#docstring-patterns

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.