Skip to content

chore: гонять примеры из README, а не обещать это комментарием - #10

Merged
mokevnin merged 1 commit into
mainfrom
chore/doctest-readme
Aug 13, 2026
Merged

mokevnin merged 1 commit into
mainfrom
chore/doctest-readme

Conversation

@mokevnin

Copy link
Copy Markdown
Contributor

В README стоял комментарий This code will be doctested. Do not touch the markup!, но доктеста не было ни в Makefile, ни в CI, а разметка была не доктестовой: отступ вместо >>> и ожидаемые значения в комментариях. Примеры не проверялись ничем и могли молча разойтись с кодом.

Блок переписан в настоящий doctest, добавлены цель make doctest и шаг в CI. Локально зелёный.

🤖 Generated with Claude Code

В README стояло «This code will be doctested. Do not touch the markup!», но
доктеста не было ни в Makefile, ни в CI, а сама разметка была не доктестовой:
отступ вместо >>> и ожидаемые значения в комментариях. То есть примеры никто не
проверял, и разойтись с кодом они могли молча.

Блок переписан в настоящий doctest, добавлена цель doctest и шаг в CI.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@mokevnin
mokevnin merged commit 8611e7b into main Aug 13, 2026
2 checks passed
@mokevnin
mokevnin deleted the chore/doctest-readme branch August 13, 2026 00:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant