fix: mark README doctests as ignore to fix CI failures - #34
Merged
Conversation
The code examples reference external crates (tikv-jemallocator, axum) that are not available in the doctest environment, causing compilation errors. Change `rust,no_run` to `rust,ignore` for these blocks.
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the repository documentation examples and adds dependencies needed for allocator profiling and an HTTP endpoint example.
Changes:
- Switch README Rust code fences from
no_runtoignore - Add
tikv-jemallocatorandaxumtoCargo.toml
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adjusts Rust code-fence attributes for the allocator + HTTP server examples |
| Cargo.toml | Adds crates referenced by the README examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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 code examples reference external crates (tikv-jemallocator, axum)
that are not available in the doctest environment, causing compilation
errors. Change
rust,no_runtorust,ignorefor these blocks.cc @umanwizard