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

Decide on ordering of Tx/Rx pairs in APIs #1986

Closed
MabezDev opened this issue Aug 22, 2024 · 4 comments · Fixed by #2074
Closed

Decide on ordering of Tx/Rx pairs in APIs #1986

MabezDev opened this issue Aug 22, 2024 · 4 comments · Fixed by #2074
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@MabezDev
Copy link
Member

We should decide on an order, and add it to the API guidelines, then check that all APIs that return or consume a tx/rx pair use that order.

@MabezDev MabezDev added the documentation Improvements or additions to documentation label Aug 22, 2024
@bugadani
Copy link
Contributor

Well, obviously tx, rx is the only right way to do it :)

Btw we might want to think about this a bit more generally, there are some inconsistent things in the HAL, like:

image
(timer, clocks, vs clocks, timer)

@AnthonyGrondin
Copy link
Contributor

embassy-net and smoltcp both seem to be using rx, tx.

@tom-borcin tom-borcin added this to the 0.21.0 milestone Aug 27, 2024
@MabezDev
Copy link
Member Author

In our internal meeting we decided to try and be consistent with the ecosystem, we will use rx, tx.

@SergioGasquez SergioGasquez self-assigned this Sep 3, 2024
@SergioGasquez SergioGasquez linked a pull request Sep 4, 2024 that will close this issue
6 tasks
@SergioGasquez
Copy link
Member

Well, obviously tx, rx is the only right way to do it :)

Btw we might want to think about this a bit more generally, there are some inconsistent things in the HAL, like:

image (timer, clocks, vs clocks, timer)

I guess after #1999 clocks/timer is no longer an issue

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.

5 participants