Documenting a number of peripherals and packages #680
Conversation
bugadani
left a comment
bugadani
left a comment
There was a problem hiding this comment.
So I'm not a team member or anything, so you don't actually need to address any of these, but maybe 🥺
I've run through the PR with a spell checker, and marked a few places where the wording is a bit awkward, or redundant. I've also pointed out a few styling things. Sorry if I've been more critical if I should have.
I didn't go through all MCU-specific modules in soc, but I think my comments on esp32 apply to all.
Mad respect for doing this! rustdoc actually didn't report any new warnings to me locally, so hopefully if this and #668 gets merged, we'll have a biiiiig set of warning-free documentation 🎉
playfulFence
force-pushed
the
issues/docs
branch
from
e912f89 to
281eab6
Compare
jessebraham
left a comment
jessebraham
left a comment
There was a problem hiding this comment.
A bunch of nit-picky spelling and grammar mistakes (sorry 😁) for now, still need to do more reviewing.
playfulFence
force-pushed
the
issues/docs
branch
from
61d3baa to
fb97a65
Compare
jessebraham
left a comment
jessebraham
left a comment
There was a problem hiding this comment.
There will still be at least one more round of reviewing (sorry, there's a lot to review 😁) but I have some more feedback in the meantime. Will do my best to get this all wrapped up this week, sorry for the delay.
jessebraham
left a comment
jessebraham
left a comment
There was a problem hiding this comment.
Okay left a few more comments, will probably leave it at that.
More modules documented
formatting Fix typo
Fix typo
Co-authored-by: Dániel Buga <[email protected]> Fix typo Co-authored-by: Dániel Buga <[email protected]> Fix typo Co-authored-by: Dániel Buga <[email protected]> Fix typo Co-authored-by: Dániel Buga <[email protected]> fix typo Co-authored-by: Dániel Buga <[email protected]> Fix typo Co-authored-by: Dániel Buga <[email protected]> Fix typo Co-authored-by: Scott Mabin <[email protected]> Fixing typos, mistakes, improving docs.
playfulFence
force-pushed
the
issues/docs
branch
from
fd9b472 to
58be0b2
Compare
jessebraham
left a comment
jessebraham
left a comment
There was a problem hiding this comment.
Thank you for making all those additional changes, I think we can call this "good enough" for now 😁 Thank you yet again for your work on this, and sorry it took so long to get reviewed!
* Initial documentation improvements * More documentation improvements * More documentation improvements More modules documented * Finished SOC documentation for esp32 + TWAI * Fix: fix incorrect formatting * Adding more documentation to rom, and soc peripherals for multiple chips * Adding documentation for multiple peripherals * Adding SOC module documentation * Analog and clock modules are documented * Adding module-level documentation for DMA and INTERRUPT peripherals * Finishing job + minor fixes * Fix unopened HTML break * Rustfmt adjustment formatting Fix typo * Add CHANGELOG record Fix typo * Fix typos, mistakes, improving docs Co-authored-by: Dániel Buga <[email protected]> Fix typo Co-authored-by: Dániel Buga <[email protected]> Fix typo Co-authored-by: Dániel Buga <[email protected]> Fix typo Co-authored-by: Dániel Buga <[email protected]> fix typo Co-authored-by: Dániel Buga <[email protected]> Fix typo Co-authored-by: Dániel Buga <[email protected]> Fix typo Co-authored-by: Scott Mabin <[email protected]> Fixing typos, mistakes, improving docs. * Fix formatting, mistakes and typos * Fixing a bunch of logical, grammatical and formatting mistakes
4 participants
Covers most of checkboxes in #29 :
(PS. sorry for huge PR)