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

Move reset to DisplayModeTrait #126

Merged
merged 3 commits into from
Jun 12, 2020

Conversation

bugadani
Copy link
Contributor

The functionality is common, so the implementation can be as well.

Hi! Thank you for helping out with SSD1306 development! Please:

  • Check that you've added documentation to any new methods
  • Rebase from master if you're not already up to date
  • Add or modify an example if there are changes to the public API
  • Add a CHANGELOG.md entry in the Unreleased section under the appropriate heading (Added, Fixed, Changed, etc)
  • Run rustfmt on the project with cargo fmt --all - CI will not pass without this step
  • Check that your branch is up to date with master and that CI is passing once the PR is opened

PR description

Just a bit of cleanup. Should be backwards compatible since the trait is in the prelude. I don't think there should be a changelog entry for this one.

The functionality is common, so the implementation can be as well.
Copy link
Collaborator

@jamwaffles jamwaffles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall, but I disagree about the changelog. It's sort of-kinda-not breaking, but might break things for people that don't like using preludes. I'd suggest adding something like the following to the Changed section:

- [#126](https://github.com/jamwaffles/ssd1306/pull/126) Moved `reset` method to `DisplayModeTrait`. If the prelude is not used, add either `use ssd1306::prelude::*` or `ssd1306::mode::displaymode::DisplayModeTrait` to your imports.

@bugadani
Copy link
Contributor Author

Fair enough. I also marked it as breaking

Copy link
Collaborator

@jamwaffles jamwaffles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One last nit then this can be merged :)

CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: James Waples <james@wapl.es>
Copy link
Collaborator

@jamwaffles jamwaffles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for bearing with me

@bugadani
Copy link
Contributor Author

No worries, thanks for accepting my contributions :)

@jamwaffles jamwaffles merged commit 95772ff into rust-embedded-community:master Jun 12, 2020
@jamwaffles jamwaffles mentioned this pull request Jun 12, 2020
6 tasks
@jamwaffles
Copy link
Collaborator

Any time!

@bugadani bugadani deleted the cleanup branch June 12, 2020 13:23
@bugadani bugadani mentioned this pull request Jun 12, 2020
4 tasks
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.

None yet

2 participants