Skip to content

docs: show the README examples in Python and Rust, and run every language's examples in its suite - #86

Merged
Mearman merged 2 commits into
mainfrom
docs/readme-languages
Nov 20, 2026
Merged

Mearman merged 2 commits into
mainfrom
docs/readme-languages

Conversation

@Mearman

@Mearman Mearman commented Nov 20, 2026

Copy link
Copy Markdown
Member

The root README's worked example and URL read were JavaScript only. Adds the Python and Rust forms, runs the README's Rust blocks as doctests beside the usage guide's, and adds a pytest and a node test that execute each language's examples from README.md and docs/usage.md as written (a block reading a published URL is the one skip).

…uage's examples in its suite

The README's worked example and its URL read were JavaScript only. Each now has
the Python and Rust forms, and the Rust blocks of the README join the usage
guide as doctests. The Python and npm suites run the examples of both documents
as written, skipping only the blocks that read a published URL.
@Mearman
Mearman enabled auto-merge (rebase) November 20, 2026 08:30
@Mearman
Mearman merged commit 87b1027 into main Nov 20, 2026
25 checks passed
@Mearman
Mearman deleted the docs/readme-languages branch November 20, 2026 08:34
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 0.12.4 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant