Add basic spi compile doctest #693
Closed
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
- Run with `cd esp-hal-common` & `cargo test --doc -Zdoctest-xcompile --features esp32c3 --target riscv32imc-unknown-none-elf spi`
bugadani
reviewed
Jul 26, 2023
| //! # let mut system = peripherals.DPORT.split(); | ||
| //! # let mut peripheral_clock_control = system.peripheral_clock_control; | ||
| //! # let mut clocks = ClockControl::boot_defaults(system.clock_control).freeze(); | ||
| //! # |
There was a problem hiding this comment.
Suggested change
| //! # | |
| //! # |
rustfmt doesn't leave us any space.
|
Maybe this is worth revisiting now? The panic handler situation is still sub-optimal, however the |
|
I've created an issue to further investigate this; since we are not going to merge this, going to close this PR now. Thanks for the idea and proof-of-concept, though! |
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.
Run with
cd esp-hal-common&cargo test --doc -Zdoctest-xcompile --features esp32c3 --target riscv32imc-unknown-none-elf spi.It sucks that we need to add a panic handler, and that SYSTEM/DPORT/PCR needs to be cfg'd (maybe we should abstract this in a different way, or consider unifying the name), but other than that it works pretty well.
FYI this is what the final documentation looks like:
Thank you!
Thank you for your contribution.
Please make sure that your submission includes the following:
Must
errorsorwarnings.cargo fmtwas run.CHANGELOG.mdin the proper section.Nice to have