Repository navigation
docs: show the README examples in Python and Rust, and run every language's examples in its suite - #86
Merged
Conversation
…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.
|
🎉 This PR is included in version 0.12.4 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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).