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

Add #![deny(missing_docs)] to the aes, analog, clock, and dma modules #1849

Merged
merged 6 commits into from
Jul 25, 2024

Conversation

jessebraham
Copy link
Member

I'm going to just start slowly adding this attribute to modules and updating the documentation as needed. Eventually we can add it to the package root and remove all these, but I think this is the easiest path forward for now.

I've also removed the ENCRYPT_MODE and DECRYPT_MODE constants from the AesFlavour trait, as they don't appear to actually be used anywhere. If they are indeed required for something let me know and I will re-add them, but they needed docstrings so I decided to just delete them instead 🤷🏻‍♂️

@MabezDev
Copy link
Member

Maybe we should delay this PR until #1824 as we'll have more coverage once that's merged?

@jessebraham jessebraham marked this pull request as draft July 23, 2024 21:29
@jessebraham jessebraham force-pushed the feature/deny-missing-docs branch from da18560 to 83cf135 Compare July 24, 2024 13:01
@jessebraham jessebraham marked this pull request as ready for review July 24, 2024 13:10
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.

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

@bjoernQ bjoernQ added this pull request to the merge queue Jul 25, 2024
Merged via the queue into esp-rs:main with commit 45db1b5 Jul 25, 2024
18 checks passed
@jessebraham jessebraham deleted the feature/deny-missing-docs branch July 25, 2024 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants