almindor / mipidsi

MIPI Display Serial Interface unified driver
MIT License
108 stars 47 forks source link

Find a better place for the reset pin warning in the `Builder::init` docs #132

Closed rfuest closed 1 month ago

rfuest commented 2 months ago

The docs for the init method still contain this warning about the correct state of the reset pin: https://docs.rs/mipidsi/latest/mipidsi/struct.Builder.html#warning. This place doesn't make sense anymore, now that the init method no longer takes the reset pin as a parameter.

Adding the warning to Builder::reset_pin wouldn't be very discoverable in my opinion. Perhaps the troubleshooting doc would be a better place to mention this?