therealprof / display-interface

Rust crates providing a generic interface for display drivers and some default implementations (GPIO, SPI and I2C)
Apache License 2.0
73 stars 27 forks source link

Propose to use CamelCase for SpiInterface structure #45

Closed luojia65 closed 8 months ago

luojia65 commented 8 months ago

I'd like to propose that we name the SPI interface structure SpiInterface other than SPIInterface, for that:

In UpperCamelCase, acronyms and contractions of compound words count as one word: use Uuid rather than UUID, Usize rather than USize or Stdin rather than StdIn. In snake_case, acronyms and contractions are lower-cased: is_xid_start.

... in this case, SPI can be treated as an acronym, it counts as one word, so only the first 'S' should be upper cased.

r? @bugadani

bugadani commented 8 months ago

Thanks! Would you please update the other crates too, for consistency, and add a changelog entry (after rebasing, to the new Unreleased section)?

luojia65 commented 8 months ago

@bugadani : I've pushed one commit (squashed) to include SpiInterface, I2cInterface and PGpioXBitInterface structures. r?

bugadani commented 8 months ago

Thanks!