Include the readme in rustdoc #225
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR includes the README documentation in the rustdoc output for both twirp and twirp-build crates, and updates code block formatting in the README to prevent rustdoc test failures while maintaining syntax highlighting.
- Adds
#![doc = include_str!(...)]attributes to include README content in rustdoc - Updates README code blocks from
rusttorust ,ignoreto prevent test execution - Adds explanatory comments about the code block syntax choices
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| crates/twirp/src/lib.rs | Includes the crate's README in rustdoc output |
| crates/twirp-build/src/lib.rs | Includes the twirp README in rustdoc output |
| crates/twirp/README.md | Updates code blocks to use rust ,ignore syntax with explanatory comments |
tclem
approved these changes
Jul 30, 2025
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.
Replaces #12
Here's what the
twirprustdoc page looks like:Here's what the
twirp-buildrustdoc page looks like: