Fix DMAC documentation #703
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
|
Thank you! |
benvonhandorf
pushed a commit
to benvonhandorf/atsamd
that referenced
this pull request
Nov 29, 2023
* Added the dma feature to package.metadata.docs.rs in Cargo.toml * Added a compile error for the condition of library + dma features * Updated CHANGELOG.md to include DMAC documentation fixes --------- Co-authored-by: avawolfe <ava.wolfe@ooma.com>
benvonhandorf
pushed a commit
to benvonhandorf/atsamd
that referenced
this pull request
Nov 29, 2023
* Added the dma feature to package.metadata.docs.rs in Cargo.toml * Added a compile error for the condition of library + dma features * Updated CHANGELOG.md to include DMAC documentation fixes --------- Co-authored-by: avawolfe <ava.wolfe@ooma.com>
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.
Summary
The current documentation for the HAL on crates.io does not include documentation for the DMAC peripheral. This PR modifies the metadata to include the
dmatrait such that this is included in the online documentation. Simultaneously, thedmaandlibraryfeatures should not be combined, due todmaenabling code that relies on a PAC across many source files. A compile error is added to prohibit compilation withdmaandlibraryfeatures combined.