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

Activate clippy checks on exported APIs #587

Merged
merged 1 commit into from
Apr 23, 2023

Conversation

jannic
Copy link
Member

@jannic jannic commented Apr 21, 2023

Today I learned about the avoid-breaking-exported-api = false clippy config.

https://doc.rust-lang.org/stable/clippy/lint_configuration.html?highlight=avoid-breaking-exported-api#avoid-breaking-exported-api

While a clippy warning probably is not a good justification for a breaking change, such warnings can be useful to avoid issues in new APIs.

The number of issues clipply flags for existing APIs is managable, so I propose adding that config, and add matching allow annotations to override warnings in the current API.

Today I learned about the `avoid-breaking-exported-api = false` clippy
config.

https://doc.rust-lang.org/stable/clippy/lint_configuration.html?highlight=avoid-breaking-exported-api#avoid-breaking-exported-api

While a clippy warning probably is not a good justification for a breaking
change, such warnings can be useful to avoid issues in new APIs.

The number of issues clipply flags for existing APIs is managable, so
I propose adding that config, and add matching allow annotations to
override warnings in the current API.
@jannic
Copy link
Member Author

jannic commented Apr 21, 2023

CI checks failed because of lalrpop/lalrpop#750

@jannic jannic merged commit 2c9921c into rp-rs:main Apr 23, 2023
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.

2 participants