skills.rest
ihmorol
ihmorolCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

docstring

Generate Google-style docstrings for Python functions with parameters and examples.

1|2|Updated Jan 15, 2026
Search Tags:#code quality#developer tools#documentation#python#docstring
One-click install
npx skills add https://github.com/ihmorol/unsw-nb15-handling-binary-multiclass-ids --skill docstring-ihmorol
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docstring
Source: https://github.com/ihmorol/unsw-nb15-handling-binary-multiclass-ids/tree/main/.opencode/skills/docstring
Command: npx skills add https://github.com/ihmorol/unsw-nb15-handling-binary-multiclass-ids --skill docstring-ihmorol

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive, clear, and professional docstrings for code, ensuring consistency and improving code maintainability.

Core Features & Use Cases

  • Automated Docstring Generation: Creates docstrings following the Google Style Guide.
  • Code Documentation: Enhances code readability and understanding for team collaboration.
  • Use Case: When you finish writing a Python function, use this Skill to generate a well-formatted docstring that includes parameters, return values, and examples.

Quick Start

Use the docstring skill to generate a Google-style docstring for the provided Python function.

Frequently Asked Questions about docstring

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

FAQPage Schema
How do I generate professional Python docstrings automatically?▼

You generate professional Python docstrings by providing your code to this Skill, which outputs a standardized Google-style format including summary, arguments, returns, and examples sections.

What is the Google-style format for Python code documentation?▼

Google-style format structures Python code documentation into specific sections including summary, description, arguments, returns, raises, examples, and notes to maintain consistency and improve readability.

Does this docstring generator work with any Python function?▼

Yes, this docstring generator works with any Python function, analyzing your code to automatically create a clear and comprehensive Google-style docstring tailored to that specific function.

Why use an automated docstring generator for developer tools?▼

You use an automated docstring generator to ensure consistency and improve code maintainability, automating the creation of clear documentation to enhance readability and team collaboration.

What sections are required in a Google-style Python docstring?▼

Required sections in a Google-style Python docstring include the summary, description, arguments, returns, raises, examples, and notes, ensuring all aspects of the function behavior are thoroughly documented.

Related Skills

Explore More Software Engineering Skills→
phuhao00phuhao00
12

doc-writer

Generate Google-style Python docstrings and Markdown documentation for software projects.

Community
Basic
keshavraj936keshavraj936

lint-and-validate

Lint and statically analyze Node.js and Python code modifications.

Community
Intermediate
PriyanshKuniyalPriyanshKuniyal

python-code-style

Enforce PEP 8 formatting, naming, and documentation standards in Python code.

Community
Intermediate
HomericIntelligenceHomericIntelligence
18

generate-docstrings

Generate Google, NumPy, and reStructuredText docstrings for functions and classes.

Official
Basic