almindor / mipidsi

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

Amplify documentation and add example #65

Closed Slushee-a closed 11 months ago

Slushee-a commented 11 months ago

Made this merge request as mentioned in #64.

Why

Coming into the crate I wasn't sure where DisplayInterface and Rgb565 came from, as well as which modules I needed to import. Browsing through different crate docs and looking at clippy helps you figure out all of that, but adding more, and less simplified examples saves you most of that trouble.

Changes included

Could be improved:

Slushee-a commented 11 months ago

I see what went wrong.

  1. Some code on the codeblock goes over the standard formatting limit
  2. I didn't ignore the codeblocks

I will fix this in my next commit very soon

Slushee-a commented 11 months ago

I'm really sorry... This is embarassing. Sorry for wasting your time. Apparently it failed because some trailing spaces? otherwise I can't see what made the pipeline failed. Fixed in the latest commit.

almindor commented 11 months ago

I'm really sorry... This is embarassing. Sorry for wasting your time. Apparently it failed because some trailing spaces? otherwise I can't see what made the pipeline failed. Fixed in the latest commit.

No problem at all. You're giving something to improve the library, there's nothing to feel sorry or embarrased about.