David-OConnor / stm32-hal

This library provides access to STM32 peripherals in Rust.
MIT License
147 stars 44 forks source link

Broken doc.rs #67

Open lestofante opened 1 year ago

lestofante commented 1 year ago

I have a strange issue with the docs at https://docs.rs/stm32-hal2/latest/stm32_hal2/spi/struct.SpiConfig.html if i click "Mode" image

i land to a "no result found" page.

not sure what is going on there, if a bug in the doc.rs or this project

David-OConnor commented 1 year ago

Oh weird! Same. I wonder if it has to do with the embedded_hal feature gate on the SpiModeType that it should link to. It looks like SpiMode is missing entirely from the docs.

edit: There was a recent PR that, when the embedded-hal feature was enabled, it made that field's type an EH field that handles SPI mode. If not enabled, it uses a type native to this crate's SPI module. Maybe the docs is having a struggle with the feature-gates?

David-OConnor commented 1 year ago

If anyone has thoughts or fixes on this, LMK