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 DriverMode and it's impact on drivers more thoroughly #3204

Closed
MabezDev opened this issue Mar 4, 2025 · 0 comments · Fixed by #3217
Closed

Document DriverMode and it's impact on drivers more thoroughly #3204

MabezDev opened this issue Mar 4, 2025 · 0 comments · Fixed by #3217
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@MabezDev
Copy link
Member

MabezDev commented Mar 4, 2025

Some of this content is likely to end up in the book, probably in esp-rs/book#179 (whatever we decide to call it eventually). So be sure to sync there before tackling this.

  • Document the trait itself, with code examples
  • Document the into_{async|blocking} functions on drivers
    • Explain what it does. I.e installs/uninstalls an interrupt handler etc.
@MabezDev MabezDev added the documentation Improvements or additions to documentation label Mar 4, 2025
@MabezDev MabezDev added this to the 1.0.0-beta.1 milestone Mar 4, 2025
@github-project-automation github-project-automation bot moved this to Todo in esp-rs Mar 4, 2025
@bugadani bugadani self-assigned this Mar 5, 2025
@github-project-automation github-project-automation bot moved this from Todo to Done in esp-rs Mar 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants