# docstring

Скилл автоматически добавляет Google-style docstring к модулям и классам Python. Помогает заполнить пробелы в документации, не переписывая уже готовые строки.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · ★ 17367 у репозитория
- Автор: pipecat-ai
- Лицензия: BSD-2-Clause · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/pipecat-ai/pipecat/tree/HEAD/.claude/skills/docstring/SKILL.md
- Обновлён: 2026-10-29
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/docstring

## Что делает

Скилл просматривает файл Python и добавляет docstring туда, где их нет или они неполные. Вы даёте ему имя класса или путь к модулю — он находит нужный файл, анализирует структуру и пишет описания для модуля, классов, конструкторов и публичных методов.

Документирует по порядку: модульная строка, классы, `__init__`, публичные методы, конфиги. Пропускает приватные методы, простые дандеры вроде `__str__` и уже полные docstring. Форматирует по стилю проекта: одна строка описания, секции Args, Returns, Raises с примерами для обработчиков событий.

Для поиска класса по имени скилл смотрит в `src/pipecat/`; если найдёт несколько файлов с одинаковым именем класса, попросит вас выбрать. Работает с dataclass, config-классами и enum — каждый получает описание назначения и полей.

## Установка

### Claude Code (родная платформа)

1. **Через Skills CLI (Vercel)**
```bash
npx skills add pipecat-ai/pipecat --skill docstring -a claude-code
```

2. **Вручную: положить файлы**
- Файл: `~/.claude/skills/docstring/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/docstring/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add pipecat-ai/pipecat --skill docstring -a codex
```

2. **Вручную: положить файлы**
- Файл: `.agents/skills/docstring/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add pipecat-ai/pipecat --skill docstring -a cursor
```

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/docstring/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install pipecat-ai/pipecat .claude/skills/docstring
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/docstring/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add pipecat-ai/pipecat --skill docstring -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/pipecat-ai/pipecat --path .claude/skills/docstring
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/docstring/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add pipecat-ai/pipecat --skill docstring -a opencode
```

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/pipecat-ai/pipecat/tree/HEAD/.claude/skills/docstring/SKILL.md

## Когда брать
- добавить Google-style docstring к Python-модулю
- задокументировать класс и его методы
- заполнить недостающие описания параметров конструктора
- привести документацию к единому стилю проекта

## Примеры запросов агенту
- Задокументируй модуль `src/pipecat/audio/vad/vad_analyzer.py`
- Добавь docstring для класса VADAnalyzer
- Документируй все публичные методы FrameProcessor

## Похожие
- [write-docs](https://affpapa.org/nevibecode/skills/browseros-ai-write-docs.md) — скилл · ★ 14442 у репозитория
- [qianwen-text](https://affpapa.org/nevibecode/skills/qianwen-text.md) — скилл · 6200 установок
- [humanize](https://affpapa.org/nevibecode/plugins/humanize.md) — плагин · ★ 1216 у репозитория
- [paper-to-code](https://affpapa.org/nevibecode/skills/paper-to-code.md) — скилл · 1700 установок
- [quasi-coder](https://affpapa.org/nevibecode/skills/quasi-coder.md) — скилл · 9100 установок
- [mcp-server-spec-driven-development](https://affpapa.org/nevibecode/skills/mcp-server-spec-driven-development.md) — скилл · 175 установок

Из того же набора: [pipecat-ai/pipecat](https://affpapa.org/nevibecode/by/pipecat-ai/pipecat.md) — 2 карточки

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md
