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

uart: minor docs improvements #3216

Merged
merged 2 commits into from
Mar 5, 2025
Merged

uart: minor docs improvements #3216

merged 2 commits into from
Mar 5, 2025

Conversation

JurajSadel
Copy link
Contributor

First driver of #3180. This doesn't change logic of the driver just reshuffle some functions.
I think I will work on one driver at a time to avoid ugly rebasing of multiple files.

@JurajSadel JurajSadel added the skip-changelog No changelog modification needed label Mar 5, 2025
@bjoernQ
Copy link
Contributor

bjoernQ commented Mar 5, 2025

The functions not sorted for me

image

And the impl blocks are also not really sorted

image

(Blocking, Async, Any, Blocking, Async)

Maybe we should define a sorting order

@bugadani
Copy link
Contributor

bugadani commented Mar 5, 2025

We should maybe also merge the separate Blocking and Async blocks, we don't need multiple of them.

@MabezDev
Copy link
Member

MabezDev commented Mar 5, 2025

I could have been a bit more clear in the original issue, sorry about that!

  • I think we should have only 3 impls blocks in the docs (ignoring trait impls obviously)
    • Blocking (should go first, as it's the entry point to creating most drivers)
    • Async
    • impl for Both

Re grouping inside the blocks, I think I agree with @bugadani's point (#3216 (comment)). This is more inline with how upstream Rust does it, for example: https://doc.rust-lang.org/core/primitive.i32.html#method.strict_add is placed next to the other add functions. Let's just try and organize it so that at the very least the first few items we see for a driver are stable, if possible please :D.

I think I will work on one driver at a time to avoid ugly rebasing of multiple files.

Good idea!

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

Copy link
Member

@MabezDev MabezDev left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for updating the guidelines too!

@MabezDev MabezDev added this pull request to the merge queue Mar 5, 2025
Merged via the queue into esp-rs:main with commit ef1b3cf Mar 5, 2025
27 checks passed
@JurajSadel JurajSadel deleted the uart branch March 5, 2025 19:31
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.

4 participants