Turn some not-too-useful TODOs into useful documentation #1451
Conversation
| @@ -274,7 +274,6 @@ pub struct Clocks<'d> { | |||
| pub pll_48m_clock: HertzU32, | |||
| #[cfg(esp32h2)] | |||
| pub pll_96m_clock: HertzU32, | |||
| // TODO chip specific additional ones as needed | |||
There was a problem hiding this comment.
This is now a normal process during chip-bring-up
| @@ -52,8 +52,6 @@ impl EmbassyTimer { | |||
|
|
|||
| pub fn init(clocks: &Clocks, mut timer: TimerType) { | |||
| // set divider to get a 1mhz clock. APB (80mhz) / 80 = 1mhz... | |||
| // TODO: assert APB clock is the source and its at the correct speed for the | |||
There was a problem hiding this comment.
TIMG driver doesn't currently support anything else. When that changes we need to revisit all uses anyways
| @@ -22,7 +22,12 @@ | |||
| //! registers with flexible updating methods. | |||
| //! * Fault Detection Module (Not yet implemented) | |||
| //! * Capture Module (Not yet implemented) | |||
| //! | |||
| #![doc = ""] | |||
There was a problem hiding this comment.
alternative would be to document it for all chips - I guess having just the right information for the currently selected chip is better?
There was a problem hiding this comment.
Yeah I've been wondering what we should do about this as well. I guess in this case documenting it on a per-chip basis is simple enough, so this should be fine.
There was a problem hiding this comment.
This is the nicest way to do it I've seen so far, so I'm going to steal this method :D. Thanks!
There was a problem hiding this comment.
FYI it doesn't add any newlines, so you can just inline the bit you want to change, for example:
//! The System Timer is a
#![cfg_attr(esp32s2, doc = "`64-bit`")]
#![cfg_attr(not(esp32s2), doc = "`54-bit`")]
//! timer with three comparators capable of signalling an alarm interupt on each.Creates
Which is nice.
| @@ -647,7 +647,6 @@ impl RtcClock { | |||
| (100_000_000 * 1000 / period) as u16 | |||
| } | |||
|
|
|||
| // TODO: implement for ESP32-C6, and H2 | |||
There was a problem hiding this comment.
that's already done
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 📝
CHANGELOG.mdin the proper section.Extra:
Pull Request Details 📖
Description
Some TODOs turned out to be just noise
Testing
Nothing should have changed