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

I2c rename, small docs clean up #2320

Merged
merged 5 commits into from
Oct 10, 2024
Merged

I2c rename, small docs clean up #2320

merged 5 commits into from
Oct 10, 2024

Conversation

MabezDev
Copy link
Member

@MabezDev MabezDev commented Oct 9, 2024

Thank you for your contribution!

We appreciate the time and effort you've put into this pull request.
To help us review it efficiently, please ensure you've gone through the following checklist:

Submission Checklist 📝

  • I have updated existing examples or added new ones (if applicable).
  • I have used cargo xtask fmt-packages command to ensure that all changed code is formatted correctly.
  • My changes were added to the CHANGELOG.md in the proper section.
  • I have added necessary changes to user code to the Migration Guide.
  • My changes are in accordance to the esp-rs API guidelines

Extra:

Pull Request Details 📖

Just some bits I noticed reviewing our docs, the important one being the I2C => I2c change.

@MabezDev MabezDev force-pushed the docs branch 2 times, most recently from 5805002 to 25e4e3a Compare October 9, 2024 14:57
@@ -6,36 +6,46 @@
//! things, particularly traits, which are used in almost every single Rust
//! program.

pub use fugit::{ExtU64 as _fugit_ExtU64, RateExtU32 as _fugit_RateExtU32};
pub use nb;
pub use prelude::*;
Copy link
Contributor

Choose a reason for hiding this comment

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

What's the result of this?

Copy link
Member Author

Choose a reason for hiding this comment

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

image

Imo seeing what's actually in the prelude in the docs isn't that helpful, but I'm happy to revert if you feel differently.

Copy link
Contributor

Choose a reason for hiding this comment

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

Eh whatever, I'd probably refrain from reexporting any of the things that you hid anyway.

@MabezDev MabezDev added the skip-changelog No changelog modification needed label Oct 9, 2024
@MabezDev
Copy link
Member Author

MabezDev commented Oct 9, 2024

Skip changelog for fixing esp-wifi lint

@MabezDev MabezDev force-pushed the docs branch 3 times, most recently from 61175c6 to b726c9f Compare October 9, 2024 16:57
Copy link
Member

@SergioGasquez SergioGasquez 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!

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

@jessebraham jessebraham added this pull request to the merge queue Oct 10, 2024
Merged via the queue into esp-rs:main with commit 0142703 Oct 10, 2024
28 checks passed
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.

5 participants