# pdoc

Правило задаёт формат docstring и type hints в Python-коде, который документируется через pdoc. Пригодится, когда нужно привести описание публичного API к единому виду.

- правило · `type=rule` · Cursor · ★ 3580
- Автор: sanjeed5
- Лицензия: CC0-1.0 · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/sanjeed5/awesome-cursor-rules-mdc/tree/HEAD/rules-mdc/pdoc.mdc
- Обновлён: 2026-05-19
- HTML: https://affpapa.org/nevibecode/rules/pdoc

## Что делает

Для публичных модулей, классов, функций и методов правило требует docstring в стиле Google: краткое описание, подробности, параметры, результат, исключения и пример. Оно также просит явно указывать типы аргументов, возвращаемых значений и атрибутов классов. Это основа для документации, которую строит `pdoc`.

В каждом `.py`-файле и `__init__.py` нужен обзорный docstring. Списки `__all__` помогают задать публичную часть API, а комментарии в теле функции следует оставить для объяснения нетривиальной логики. Правило предлагает добавить генерацию документации в CI/CD и проверять примеры через `doctest`; пример пайплайна использует GitHub Actions, Python 3.11 и `pdoc`. Оно нацелено на Python API: для других языков эти требования не подходят.

## Установка

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

**Вручную: положить файлы**
- Файл: `.cursor/rules/pdoc.mdc` — Во frontmatter: description, globs, alwaysApply

### Claude Code

**Вручную: положить файлы**
- Файл: `.claude/rules/pdoc.md` — Поле paths во frontmatter ограничивает файлы: globs из источника → paths

### Codex

**AGENTS.md**
- Codex читает AGENTS.md: вставьте текст правила туда

### GitHub Copilot

**Вручную: положить файлы**
- Файл: `.github/instructions/pdoc.instructions.md` — Поле applyTo задаёт, к каким файлам применять: globs из источника → applyTo

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/rules/pdoc.md`

### Cline

**Вручную: положить файлы**
- Файл: `.clinerules/pdoc.md`

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/sanjeed5/awesome-cursor-rules-mdc/tree/HEAD/rules-mdc/pdoc.mdc

## Когда брать
- оформить docstring публичных функций в стиле Google
- добавить type hints к аргументам и результатам
- описать назначение Python-модуля и пакета
- обозначить публичные компоненты через `__all__`
- подготовить генерацию API-документации в CI/CD

## Примеры запросов агенту
- Оформи docstring этой публичной функции в стиле Google и добавь описание параметров, результата и исключений.
- Проверь Python API в проекте: добавь недостающие type hints и обзорные docstring для модулей.
- Настрой генерацию документации через `pdoc` в GitHub Actions по примеру правила.

## Похожие
- [revops-hiring](https://affpapa.org/nevibecode/skills/revops-hiring.md) — скилл · 20400 установок
- [revenue-reporting](https://affpapa.org/nevibecode/skills/revenue-reporting.md) — скилл · 19800 установок
- [devrel-radar](https://affpapa.org/nevibecode/skills/devrel-radar.md) — скилл · 10700 установок
- [developer-relations-kickoff](https://affpapa.org/nevibecode/skills/developer-relations-kickoff.md) — скилл · 10700 установок
- [decision-records](https://affpapa.org/nevibecode/skills/decision-records.md) — скилл · 6900 установок
- [open-knowledge](https://affpapa.org/nevibecode/skills/open-knowledge.md) — скилл · 4600 установок

Из того же набора: [sanjeed5/awesome-cursor-rules-mdc](https://affpapa.org/nevibecode/by/sanjeed5/awesome-cursor-rules-mdc.md) — 240 карточек

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

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