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

Private details should not leak into the public API #2766

Closed
bugadani opened this issue Dec 13, 2024 · 4 comments · Fixed by #2856
Closed

Private details should not leak into the public API #2766

bugadani opened this issue Dec 13, 2024 · 4 comments · Fixed by #2856
Assignees
@bjoernQ
Labels
1.0-blocker
Milestone
0.23.0

Comments

@bugadani
Copy link
Contributor

bugadani commented Dec 13, 2024 •
edited
Loading

Depends whether we consider State, Info and Instance private. They are public and not hidden. Info exposes the RegisterBlock and system::Peripheral enum - which is necessary if we consider Info part of a public, low-level API. The resolution of this point should also be reflected in the API-GUIDELINES under Driver implementation, as a clarification.
@bugadani bugadani mentioned this issue Dec 13, 2024
Open
38 tasks
@bugadani bugadani changed the title I2C: Private details should not leak into the public API Private details should not leak into the public API Dec 13, 2024
@bugadani bugadani removed the peripheral:i2c I2C peripheral label Dec 13, 2024
@bugadani bugadani mentioned this issue Dec 13, 2024
Open
@bugadani
Copy link
Contributor Author

Also includes

@bugadani bugadani mentioned this issue Dec 13, 2024
Closed
@MabezDev MabezDev added this to the 1.0.0-beta.0 milestone Dec 17, 2024
@bjoernQ
Copy link
Contributor

bjoernQ commented Dec 18, 2024

We all agree to doc-hide State, Info and Instance?

@MabezDev
Copy link
Member

We all agree to doc-hide State, Info and Instance?

Yes. Could you amend the guidelines to do that for new drivers too?

@bugadani
Copy link
Contributor Author

Added a clarification to #2832

@bjoernQ bjoernQ self-assigned this Dec 20, 2024
@bjoernQ bjoernQ mentioned this issue Dec 20, 2024
Merged
6 tasks
@github-project-automation github-project-automation bot moved this from Todo to Done in esp-rs Dec 23, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@bjoernQ bjoernQ

Labels
1.0-blocker
Projects
esp-rs
Archived in project
Milestone
0.23.0
Development

Successfully merging a pull request may close this issue.

Hide Info,State,Instance bjoernQ/esp-hal
3 participants
@bugadani @bjoernQ @MabezDev