Skip to content

Adding metadata

Adding metadata #430

GitHub Actions / clippy succeeded Feb 1, 2024 in 0s

clippy

5 warnings

Details

Results

Message level Amount
Internal compiler error 0
Error 0
Warning 5
Note 0
Help 0

Versions

  • rustc 1.75.0 (82e1608df 2023-12-21)
  • cargo 1.75.0 (1d8b05cdd 2023-11-20)
  • clippy 0.1.75 (82e1608 2023-12-21)

Annotations

Check warning on line 74 in src/main.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

useless conversion to the same type: `[output_channel::OutputChannel; 4]`

warning: useless conversion to the same type: `[output_channel::OutputChannel; 4]`
  --> src/main.rs:74:29
   |
74 |             output_channel: [Default::default(); 4].into(),
   |                             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: consider removing `.into()`: `[Default::default(); 4]`
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#useless_conversion
   = note: `#[warn(clippy::useless_conversion)]` on by default

Check warning on line 101 in src/net/mod.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

this function has too many arguments (8/7)

warning: this function has too many arguments (8/7)
   --> src/net/mod.rs:92:5
    |
92  | /     pub fn new(
93  | |         stack: NetworkStack,
94  | |         phy: EthernetPhy,
95  | |         clock: SystemTimer,
...   |
100 | |         metadata: &'static ApplicationMetadata,
101 | |     ) -> Self {
    | |_____________^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_many_arguments
    = note: `#[warn(clippy::too_many_arguments)]` on by default

Check warning on line 5 in src/hardware/system_timer.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

this is an outer doc comment and does not apply to the parent module or crate

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.
  |

Check warning on line 5 in src/hardware/pwm.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

this is an outer doc comment and does not apply to the parent module or crate

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 + //!
  |

Check warning on line 12 in src/hardware/dac.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

this is an outer doc comment and does not apply to the parent module or crate

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 + //!
   |