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.

Sign up for GitHub

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

Jump to bottom

Docs: move usage examples to corresponding functions/constructors where possible #2999

Closed
playfulFence opened this issue Jan 20, 2025 · 0 comments · Fixed by #3010
Closed

Docs: move usage examples to corresponding functions/constructors where possible #2999

playfulFence opened this issue Jan 20, 2025 · 0 comments · Fixed by #3010
Assignees
@playfulFence
Labels
documentation Improvements or additions to documentation
Milestone
1.0.0-beta.0

Comments

@playfulFence
Copy link
Contributor

Various examples of driver construction or function usage should moved from module-level docs to the documentation of the corresponding constructors/functions. This way, we'll keep module-level docs clean.
@playfulFence playfulFence added the documentation Improvements or additions to documentation label Jan 20, 2025
@playfulFence playfulFence self-assigned this Jan 20, 2025
@MabezDev MabezDev added this to the 1.0.0-beta.0 milestone Jan 20, 2025
@playfulFence playfulFence mentioned this issue Jan 21, 2025
Merged
@github-project-automation github-project-automation bot moved this from Todo to Done in esp-rs Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@playfulFence playfulFence

Labels
documentation Improvements or additions to documentation
Projects
esp-rs
Status: Done
Milestone
1.0.0-beta.0
Development

Successfully merging a pull request may close this issue.

gpio, spi and i2c::master cleanup, smaller updates playfulFence/esp-hal
2 participants
@MabezDev @playfulFence