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.

Sign up for GitHub

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

Jump to bottom

Update module documentation - Part 2 #1777

Merged
merged 21 commits into from
Jul 12, 2024
Merged

Update module documentation - Part 2 #1777

merged 21 commits into from
Jul 12, 2024

Conversation

SergioGasquez
Copy link
Member

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.
  • My changes are in accordance to the esp-rs API guidelines

Extra:

Pull Request Details 📖

Description

Follow-up PR of #1763

Testing

Built the documentation and ran the doc-tests.

@SergioGasquez
docs: Update assist debug mod documentation
84bce45
@SergioGasquez
docs: Update delay mod documentation
9c8f9dd
@SergioGasquez
docs: Update ecc mod documentation
708ee98
@SergioGasquez
docs: Update hmac mod documentation
1323706
@SergioGasquez
docs: Update i2c mod documentation
543fd48
@SergioGasquez
docs: Update i2s mod documentation
c643b12
@SergioGasquez
docs: Update usb otg mod documentation
9bc05f7
@SergioGasquez
docs: Update parl_io mod documentation
6ccd8dd
@SergioGasquez
docs: Update peripheral mod documentation
02a4ae0
@SergioGasquez
docs: Update prelude mod documentation
afd2e88
@SergioGasquez
docs: Update reset mod documentation
24ba1f0
@SergioGasquez
docs: Update rmt mod documentation
a07e7b7
@SergioGasquez
docs: Update rng mod documentation
672ac2b
@SergioGasquez
docs: Update sha mod documentation
efebf1a
@SergioGasquez
docs: Update system, time and trace mod documentation
5cee656
@SergioGasquez
docs: Update uart mod documentation
13408ef
@SergioGasquez
docs: Update usb_serial_jtag mod documentation
9b17c8e
@SergioGasquez
docs: Add modules documentation format
1ffc0dc
@SergioGasquez SergioGasquez added the skip-changelog No changelog modification needed label Jul 9, 2024
playfulFence
playfulFence previously requested changes Jul 10, 2024
View reviewed changes
Copy link
Contributor

@playfulFence playfulFence left a comment

Choose a reason for hiding this comment

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

Thanks a lot for taking care of this! Here are some nitpicking in comments, some of them are more like suggestions.

esp-hal/src/otg_fs.rs Outdated Show resolved Hide resolved
esp-hal/src/otg_fs.rs Outdated Show resolved Hide resolved
esp-hal/src/hmac.rs Outdated Show resolved Hide resolved
esp-hal/src/parl_io.rs Outdated Show resolved Hide resolved
esp-hal/src/parl_io.rs Outdated Show resolved Hide resolved
esp-hal/src/reset.rs Show resolved Hide resolved
esp-hal/src/rng.rs Outdated Show resolved Hide resolved
JurajSadel
JurajSadel reviewed Jul 10, 2024
View reviewed changes
Copy link
Contributor

@JurajSadel JurajSadel left a comment

Choose a reason for hiding this comment

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

I agree with @playfulFence's suggestions, otherwise LGTM, thanks for working on this!

jessebraham
jessebraham approved these changes Jul 11, 2024
View reviewed changes
Copy link
Member

@jessebraham jessebraham left a comment

Choose a reason for hiding this comment

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

One small nitpick but otherwise I think it looks good, thanks!

esp-hal/src/i2s.rs Show resolved Hide resolved
MabezDev
MabezDev approved these changes Jul 12, 2024
View reviewed changes
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.

Thanks!

@SergioGasquez SergioGasquez added this pull request to the merge queue Jul 12, 2024
Merged via the queue into esp-rs:main with commit 7e9f9c7 Jul 12, 2024
30 checks passed
@playfulFence
Copy link
Contributor

Thanks a lot for all the changes, LGTM!
Also sorry, I was AFK for a lunch, so I couldn't approve the changes! 😅

@SergioGasquez SergioGasquez deleted the feature/documentation-2 branch July 12, 2024 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JurajSadel JurajSadel JurajSadel left review comments

@jessebraham jessebraham jessebraham approved these changes

@MabezDev MabezDev MabezDev approved these changes

@playfulFence playfulFence Awaiting requested review from playfulFence

Assignees
No one assigned
Labels
skip-changelog No changelog modification needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@SergioGasquez @playfulFence @jessebraham @MabezDev @JurajSadel