warning: use of `default` to create a unit struct
  --> src/net/telemetry.rs:54:50
   |
54 |             _telemetry: core::marker::PhantomData::default(),
   |                                                  ^^^^^^^^^^^ help: remove this call to `default`
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#default_constructed_unit_structs
   = note: `#[warn(clippy::default_constructed_unit_structs)]` on by default

warning: this is an outer doc comment and does not apply to the parent module or crate
  --> src/net/telemetry.rs:1:1
   |
1  | / ///! Thermostat Telemetry Capabilities
2  | | ///!
3  | | ///! # Design
4  | | ///! Telemetry is reported regularly using an MQTT client. All telemetry is reported in SI units
...  |
11 | | ///! required immediately before transmission. This ensures that any slower computation required
12 | | ///! for unit conversion can be off-loaded to lower priority tasks.
   | |___________________________________________________________________^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments
help: use an inner doc comment to document the parent module or crate
   |
1  + //! Thermostat Telemetry Capabilities
2  + //!
3  + //! # Design
4  + //! Telemetry is reported regularly using an MQTT client. All telemetry is reported in SI units
5  + //! using standard JSON format.
6  + //!
7  + //! In order to report ADC/DAC codes generated during the DSP routines, a telemetry buffer is
8  + //! employed to track the latest codes. Converting these codes to SI units would result in
9  + //! repetitive and unnecessary calculations within the DSP routine, slowing it down and limiting
10 + //! sampling frequency. Instead, the raw codes are stored and the telemetry is generated as
11 + //! required immediately before transmission. This ensures that any slower computation required
12 + //! for unit conversion can be off-loaded to lower priority tasks.
   |

warning: this is an outer doc comment and does not apply to the parent module or crate
 --> src/net/network_processor.rs:1:1
  |
1 | / ///! Task to process network hardware.
2 | | ///!
3 | | ///! # Design
4 | | ///! The network processir is a small taks to regularly process incoming data over ethernet, handle
5 | | ///! the ethernet PHY state, and reset the network as appropriate.
  | |__________________________________________________________________^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments
help: use an inner doc comment to document the parent module or crate
  |
1 + //! Task to process network hardware.
2 + //!
3 + //! # Design
4 + //! The network processir is a small taks to regularly process incoming data over ethernet, handle
5 + //! the ethernet PHY state, and reset the network as appropriate.
  |

warning: this is an outer doc comment and does not apply to the parent module or crate
 --> src/net/mod.rs:1:1
  |
1 | / ///! Stabilizer network management module
2 | | ///!
3 | | ///! # Design
4 | | ///! The stabilizer network architecture supports numerous layers to permit transmission of
5 | | ///! telemetry (via MQTT), configuration of run-time settings (via MQTT + Miniconf), and live data
6 | | ///! streaming over raw UDP/TCP sockets. This module encompasses the main processing routines
7 | | ///! related to Stabilizer networking operations.
  | |_________________________________________________^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments
help: use an inner doc comment to document the parent module or crate
  |
1 + //! Stabilizer network management module
2 + //!
3 + //! # Design
4 + //! The stabilizer network architecture supports numerous layers to permit transmission of
5 + //! telemetry (via MQTT), configuration of run-time settings (via MQTT + Miniconf), and live data
6 + //! streaming over raw UDP/TCP sockets. This module encompasses the main processing routines
7 + //! related to Stabilizer networking operations.
  |

warning: this is an outer doc comment and does not apply to the parent module or crate
 --> src/hardware/system_timer.rs:1:1
  |
1 | / ///! System timer used for non-RTIC compatibility
2 | | ///!
3 | | ///! # Design
4 | | ///!  `Clock` is implemented using the RTIC `app::monotonics::now()` default `Monotonic`.
5 | | ///!  That `Monotonic` must tick at 1 kHz.
  | |__________________________________________^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments
help: use an inner doc comment to document the parent module or crate
  |
1 + //! System timer used for non-RTIC compatibility
2 + //!
3 + //! # Design
4 + //!  `Clock` is implemented using the RTIC `app::monotonics::now()` default `Monotonic`.
5 + //!  That `Monotonic` must tick at 1 kHz.
  |

warning: this is an outer doc comment and does not apply to the parent module or crate
 --> src/hardware/pwm.rs:1:1
  |
1 | / ///! Thermostat TEC driver IC voltage/current limits PWM driver.
2 | | ///!
3 | | ///! The Thermostat TEC driver ICs feature current limits controlled by an analog voltage input.
4 | | ///! This voltage is controlled by the MCU using low-pass filtered PWM outputs.
5 | | ///!
  | |____^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments
help: use an inner doc comment to document the parent module or crate
  |
1 + //! Thermostat TEC driver IC voltage/current limits PWM driver.
2 + //!
3 + //! The Thermostat TEC driver ICs feature current limits controlled by an analog voltage input.
4 + //! This voltage is controlled by the MCU using low-pass filtered PWM outputs.
5 + //!
  |

warning: this is an outer doc comment and does not apply to the parent module or crate
  --> src/hardware/dac.rs:1:1
   |
1  | / ///! Thermostat DAC driver
2  | | ///!
3  | | ///! This file contains the driver for the 4 Thermostat DAC output channels.
4  | | ///! To convert a 18 bit word into an analog current Thermostat uses a DAC to
...  |
11 | | ///! TEC driver datasheet: https://datasheets.maximintegrated.com/en/ds/MAX1968-MAX1969.pdf
12 | | ///!
   | |____^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments
   = note: `#[warn(clippy::suspicious_doc_comments)]` on by default
help: use an inner doc comment to document the parent module or crate
   |
1  + //! Thermostat DAC driver
2  + //!
3  + //! This file contains the driver for the 4 Thermostat DAC output channels.
4  + //! To convert a 18 bit word into an analog current Thermostat uses a DAC to
5  + //! convert the word into a voltage and a subsequent TEC driver IC that produces
6  + //! a current proportional to the DAC voltage.
7  + //!
8  + //! The 4 channel DAC ICs share an SPI bus and are addressed using individual "sync"
9  + //! signals, similar to a chip select signal.
10 + //! DAC datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/AD5680.pdf
11 + //! TEC driver datasheet: https://datasheets.maximintegrated.com/en/ds/MAX1968-MAX1969.pdf
12 + //!
   |