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

Update module documentation for UART driver, make some more methods public #1347

Merged
merged 1 commit into from
Mar 26, 2024

Conversation

jessebraham
Copy link
Member

This is probably still not "complete", there should probably be more information regarding additional functionality such as interrupts, async operation, etc., and some more examples maybe too. But, for now I think it's an improvement at least.

There were additionally a few methods gated behind the embedded-hal feature; I thin these are actually useful to expose so have done so here, can revert that if there's a reason to though.

@jessebraham jessebraham added the skip-changelog No changelog modification needed label Mar 26, 2024
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

@bjoernQ
Copy link
Contributor

bjoernQ commented Mar 26, 2024

I guess when we take the effort to add more higher-quality examples in the docs we should really get #1095 to work. Would be a shame when those examples get outdated and won't compile anymore

Just mentioning it ... I know we have a lot to do

@jessebraham jessebraham added this pull request to the merge queue Mar 26, 2024
Merged via the queue into esp-rs:main with commit 65dca00 Mar 26, 2024
21 checks passed
@jessebraham jessebraham deleted the feature/uart-docs branch March 26, 2024 15:48
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