Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Harmonize bsp api with an eye towards clean docs #357

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

jacobrosenthal
Copy link
Member

@jacobrosenthal jacobrosenthal commented Dec 3, 2020

Just to start a discussion around what our bsp api should look like.

Most of us are using inherited a pattern that splashes the hal into the main export that ends up looking like this
https://docs.rs/pygamer/0.6.0/pygamer/

Recently merged bsps clearly rethought that. Take a look at
https://docs.rs/wio_terminal/0.2.0/wio_terminal/

I presume wed like to be harmonized. And presumably wed all like our docs to look nice.

These were the (breaking) changes I made to the pygamer and edgebadge just to generally clean them up, and ended up converging to the wio terminal style.

Though Id prefer to match whatever we all decide.

@twitchyliquid64
Copy link
Contributor

Sorry for the inconsistent style with the wio_terminal - it wasnt my intention to buck the trend, but I do think consistency is ideal.

I can also tackle updating some of the other BSPs if that would help? I have hardware for the itsybitsy's.

@jessebraham
Copy link
Contributor

jessebraham commented Dec 3, 2020

Just regarding the wio_terminal crate, that was originally in a separate repository which I created which was later merged in here. The API differences are largely my doing, but I honestly don't have a strong preference on how to do things as long as it's straight-forward.

@sajattack
Copy link
Member

@jacobrosenthal @jbeaurivage Should we close this now that pygamer has been cleaned up?

@jbeaurivage
Copy link
Contributor

I think there is still a little bit of work to do in edgebadge, but it's relatively minor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants