Allow clippy to break API, ignore a few initialism errors #2840
+66
−23
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bugadani
force-pushed
the
clippy
branch
7 times, most recently
from
17ca948 to
0400a3f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since esp-hal is not yet stable, we can enable clippy lints that would need API-breaking changes to fix. This allows us to detect potential existing issues (marked with a FIXME, or corrected in this PR), as well as future problems that we might introduce by accident.
We can keep this mechanism enabled even after the first stable release - it will prevent introducing future changes. We will need to be mindful of new lints added to this category after stabilization, though, to avoid breaking our API.
The list of issues detected isn't very large and it mostly considers enum variant naming.
skip-changelog as I created the clippy config but didn't actually make code changes to some crates.