Kernel doctests #1128
Merged
Kernel doctests #1128
Conversation
This file contains 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
ppannuto
added
bug
documentation
P-Upkeep
bradjc
approved these changes
Jul 20, 2018
niklasad1
approved these changes
Jul 20, 2018
|
bors r+ |
bors bot
added a commit
that referenced
this pull request
Jul 20, 2018
1128: Kernel doctests r=niklasad1 a=ppannuto ### Pull Request Overview This adds CI checks to validate that our example code in documentation is correct by running doctests. This also fixes up some broken documentation :) This PR is just for the kernel crate. Some notes: - Lines prefixed with `# ` in doc comments are not rendered - All fenced blocks are assumed to be rust unless stated otherwise, so rustdoc repurposes the code identifier a bit, e.g. a block with ` ```ignore ` will render as rust code but will not be tested - The peripherals docs are a bit messy to look at in source code form. Personally I think this is a shortcoming of rustdoc, but I think it's good to see an example of how you handle situations where there's a sort of "continuing example" throughout the documentation (you have to keep repeating the "hidden" code with `# `) ### Testing Strategy Compiling. ### Documentation Updated - [x] Updated the relevant files in `/docs`, or no updates are required. ### Formatting - [x] Ran `make formatall`. Co-authored-by: Pat Pannuto <pat.pannuto@gmail.com>
Build succeeded |
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.
Pull Request Overview
This adds CI checks to validate that our example code in documentation is correct by running doctests. This also fixes up some broken documentation :)
This PR is just for the kernel crate.
Some notes:
#in doc comments are not rendered```ignorewill render as rust code but will not be tested#)Testing Strategy
Compiling.
Documentation Updated
/docs, or no updates are required.Formatting
make formatall.