Open jessebraham opened 7 months ago
Not sure where to drop this, but if we want to test for documentation coverage of the public APIs in CI, we could do something like:
cargo rustdoc -q -- -Z unstable-options --show-coverage | grep -i total | grep -oE '[0-9]*\.[0-9]*%' | head -n1 | grep -q 100.0%
We probably also want to double check what we want to hide from the docs
e.g. here: https://docs.rs/esp32s3-hal/0.15.0/esp32s3_hal/gpio/index.html - GpioXSignals
is pretty much useless for users of the HAL
https://docs.rs/esp32s3-hal/0.15.0/esp32s3_hal/gpio/trait.GpioProperties.html - the whole trait is probably cryptic and useless for most users
Not a priority but always I look into the docs I think about this and quickly forget about then
Working on #1276
There are a number of changes we would like to make to our documentation, so this will serve as a tracking issue (or an "epic", if you will) for each individual task.
If you would like to complete one of these tasks, please assign yourself to the issue if one already exists, or create a new issue and assign yourself to it.
doc_cfg
feature to document which cargo features are required for modules/types/etc.espflash
docs for example of this: https://docs.rs/espflash/latest/espflash/Package metadata: https://github.com/esp-rs/espflash/blob/main/espflash/Cargo.toml#L17-L18cfg
away (or add) chip specific documentation for driversinterrupt
module is too generic, and the example isn't correct. Improved via https://github.com/esp-rs/esp-hal/pull/1310