ce-docstring-author

Community

Write NumPy-style docstrings for CE APIs.

AuthorMoffran
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Automates and standardizes the creation and repair of NumPy-style docstrings for CE public APIs, ensuring consistency with STD-002 and contributor guidelines.

Core Features & Use Cases

  • Write or repair NumPy-style docstrings for public CE symbols across modules and libraries.
  • Load templates and patterns from references/docstring_patterns.md to enforce CE-specific conventions.
  • Validate docstrings against the canonical order (Summary, Parameters, Returns, Raises, Notes, References, Examples) and provide guidance for improvements.

Quick Start

Provide a NumPy-style docstring for a public CE function, following the project conventions.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 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: ce-docstring-author
Download link: https://github.com/Moffran/calibrated_explanations/archive/main.zip#ce-docstring-author

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 223,000+ vetted skills library on demand.