Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

Misc UART module-level documentation issues #2744

Closed
Tracked by #2495
bugadani opened this issue Dec 12, 2024 · 1 comment · Fixed by #2996
Closed
Tracked by #2495

Misc UART module-level documentation issues #2744

bugadani opened this issue Dec 12, 2024 · 1 comment · Fixed by #2996
Assignees
@playfulFence
Labels
1.0-blocker documentation Improvements or additions to documentation peripheral:uart UART peripheral
Milestone
1.0.0-beta.0

Comments

@bugadani
Copy link
Contributor

  • Inverting RX and TX Pins: this example belongs in the GPIO interconnect module, not in UART.
  • Operation with interrupts that by UART/Serial [sic]: First up, the title is at least missing a word. The default pin assignments should probably be listed separately in the module docs - the information is valuable and shouldn't be tied to the example.
  • Different examples on how to construct the driver should probably be moved to the relevant constructors.
  • Links to dependencies should use the intra-doc link syntax
@bugadani bugadani mentioned this issue Dec 12, 2024
Open
42 tasks
@bugadani bugadani changed the title Misc UART documentation issues Misc UART module-level documentation issues Dec 13, 2024
@tom-borcin tom-borcin added the documentation Improvements or additions to documentation label Dec 17, 2024
@playfulFence
Copy link
Contributor

Different examples on how to construct the driver should probably be moved to the relevant constructors.

I think this can be applied to almost every driver we have 🤔.
Also, by solving this problem, we will somehow reasonably cover #2623

Maybe let's cover that within the above-mentioned issue?

@playfulFence playfulFence self-assigned this Jan 20, 2025
@playfulFence playfulFence mentioned this issue Jan 20, 2025
Merged
@MabezDev MabezDev added this to the 1.0.0-beta.0 milestone Jan 20, 2025
@github-project-automation github-project-automation bot moved this from Todo to Done in esp-rs Jan 21, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@playfulFence playfulFence

Labels
1.0-blocker documentation Improvements or additions to documentation peripheral:uart UART peripheral
Projects
esp-rs
Archived in project
Milestone
1.0.0-beta.0
Development

Successfully merging a pull request may close this issue.

UART documentation fixes playfulFence/esp-hal
4 participants
@bugadani @MabezDev @playfulFence @tom-borcin