Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document package features and supported image formats #758

Merged
merged 3 commits into from
Aug 28, 2023

Conversation

jessebraham
Copy link
Member

Documents the cargo features for each chip-specific HAL package. Additionally documents the image formats, which were removed from the READMEs in #750.

Pretty minimal but better to have something rather than nothing, we can improve upon it incrementally.

@jessebraham jessebraham added the skip-changelog No changelog modification needed label Aug 28, 2023
Copy link
Contributor

@bjoernQ bjoernQ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jessebraham jessebraham changed the title Fixes/docs Document package features and supported image formats Aug 28, 2023
@jessebraham jessebraham merged commit ecb3c31 into esp-rs:main Aug 28, 2023
@jessebraham jessebraham deleted the fixes/docs branch August 28, 2023 14:38
playfulFence pushed a commit to playfulFence/esp-hal that referenced this pull request Sep 26, 2023
* Hide internal-only RMT macros from documentation

* Document the features of each chip-specific HAL package

* Document the supported image formats for relevant packages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No changelog modification needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants