search

rust-embedded-community / usb-device

Experimental device-side USB framework for microcontrollers in Rust.
MIT License
451 stars 76 forks source link

Documentation updates #134

Closed ianrrees closed 1 year ago

ianrrees commented 1 year ago

If https://github.com/rust-embedded-community/usb-device/pull/133 is accepted, this should have the explicit use for LangID removed from the example code.

ianrrees commented 1 year ago

I've force-pushed changes to bump the patch version.

Also can report that the tests pass on ATSAMD21 and ATSAMD51 boards when using a branch of the HAL that has a couple minor updates to work with the newer usb-device. Once the HAL changes are merged, I'll aim to get back to https://github.com/rust-embedded-community/usb-device/issues/100

ithinuel commented 1 year ago

Hello, can we use this opportunity to make BuilderError public or does it need it's own PR?

ianrrees commented 1 year ago

Sounds good to me! @ithinuel does the new commit work for your purpose?

ithinuel commented 1 year ago

It does, thank you 👍

ianrrees commented 1 year ago

Sorry to throw this in at the last minute (and end of a long day for me - apologies if this doesn't make sense!) but I'm wondering if BuilderError is maybe too generic of a name, for something that is put in the prelude - lots of things use Builder... Maybe UsbBuilderError, or a super-verbose UsbDeviceBuilderError?

ryan-summers commented 1 year ago

If people don't like the name, they can rename it during import. The same argument can be made for Error