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

refactor(clippy): enable breaking lint checks #988

Merged
merged 2 commits into from May 14, 2024
Merged

refactor(clippy): enable breaking lint checks #988

merged 2 commits into from May 14, 2024

Conversation

EdJoPaTo
Copy link
Member

We need to make sure to not change existing methods without a notice. But at the same time this also finds public additions with mistakes before they are even released which is what I would like to have.

This renames a method and deprecated the old name hinting to a new name. Should this be mentioned somewhere, so it's added to the release notes? It's not breaking because the old method is still there.

clippy.toml Show resolved Hide resolved
Copy link
Member

@joshka joshka left a comment

Choose a reason for hiding this comment

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

For the to => into change, can you split this off to another PR with a changelog friendly message (i.e. note to_xxx is deprecated use into_xxx instead and the rationale for why). See the changelog for examples of this (these come through verbatim from the PR text unless we specifically write something).

\The breaking change for that is the removal of the to_methods at some point in the future, so no need to note it in the breaking changes doc (unless we want to create a future breaking changes section?).

src/layout/rect.rs Outdated Show resolved Hide resolved
src/widgets/gauge.rs Show resolved Hide resolved
src/widgets/scrollbar.rs Outdated Show resolved Hide resolved
Copy link
Member

@joshka joshka left a comment

Choose a reason for hiding this comment

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

LGTM Agree on merging and then removing the lints when we fix them.

src/layout/rect.rs Outdated Show resolved Hide resolved
We need to make sure to not change existing methods without a notice. But at the same time this also finds new methods with mistakes which is what I would like to have.
@EdJoPaTo
Copy link
Member Author

Include this into the next bugfix version or wait for a breaking change release?

@joshka
Copy link
Member

joshka commented May 14, 2024

Include this into the next bugfix version or wait for a breaking change release?

To the best of my understanding, this doesn't break anything, so merging it now.

@joshka joshka merged commit 9bd89c2 into main May 14, 2024
33 checks passed
@joshka joshka deleted the clippy-breaking branch May 14, 2024 01:16
joshka pushed a commit to nowNick/ratatui that referenced this pull request May 24, 2024
We need to make sure to not change existing methods without a notice.
But at the same time this also finds public additions with mistakes
before they are even released which is what I would like to have.

This renames a method and deprecated the old name hinting to a new name.
Should this be mentioned somewhere, so it's added to the release notes?
It's not breaking because the old method is still there.
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

3 participants