docs: hide boilerplate from documentation examples#261
Open
jayendra13 wants to merge 1 commit intorust-vmm:mainfrom
Open
docs: hide boilerplate from documentation examples#261jayendra13 wants to merge 1 commit intorust-vmm:mainfrom
jayendra13 wants to merge 1 commit intorust-vmm:mainfrom
Conversation
Use Rust's doc-test hiding feature (# prefix) to hide extern crate and use statements from rendered documentation while keeping them for compilation. This reduces visual clutter in the docs and lets users focus on the actual usage code. Files updated: - src/errno.rs - src/tempfile.rs - src/align.rs - src/unix/event.rs - src/linux/epoll.rs - src/linux/eventfd.rs - src/linux/timerfd.rs - src/linux/signal.rs - src/linux/ioctl.rs - src/unix/terminal.rs - src/fam.rs Fixes: rust-vmm#81 Signed-off-by: jayendra13 <jayendra0parmar@gmail.com>
jayendra13
requested review from
ShadowCurse,
andreeaflorescu,
jiangliu,
liujing2,
roypat and
sameo
as code owners
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
1 participant
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.
Use Rust's doc-test hiding feature (# prefix) to hide extern crate and use statements from rendered documentation while keeping them for compilation. This reduces visual clutter in the docs and lets users focus on the actual usage code.
Files updated:
Fixes: #81
Summary of the PR
Please summarize here why the changes in this PR are needed.
Requirements
Before submitting your PR, please make sure you addressed the following
requirements:
git commit -s), and the commit message has max 60 characters for thesummary and max 75 characters for each description line.
test.
Release" section of CHANGELOG.md (if no such section exists, please create one).
unsafecode is properly documented.