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

Update lints defintion and deny config #74

Merged
merged 16 commits into from
Oct 7, 2024
Merged

Update lints defintion and deny config #74

merged 16 commits into from
Oct 7, 2024

Conversation

bheylin
Copy link
Collaborator

@bheylin bheylin commented Oct 2, 2024

  • The GitHub CI will now fail on clippy warnings.
  • Lint definitions have been converted to opt-out.
  • Lints are defined in the Cargo.toml.
  • Lints that are allowed because they don's provide value are clearly documented.
  • Update the deny.toml to the latest version.
  • Rm the missing_docs lint as it's resulting in obvious docs.
  • Add script that apes the GitHub workflow locally.

@bheylin bheylin requested a review from remkop22 October 2, 2024 09:45
@bheylin bheylin self-assigned this Oct 2, 2024
@@ -1,4 +1,3 @@
#![deny(missing_docs)]
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is resulting in docs that state the obvious.

/// be billed in blocks of 5 minutes, so if 6 minutes is used, 10 minutes (2
/// blocks of step_size) will be billed
/// blocks of `step_size`) will be billed
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

These changes are the result of running cargo clippy --fix with doc_markdown=warn.

Copy link
Collaborator

@remkop22 remkop22 left a comment

Choose a reason for hiding this comment

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

Nice, thanks!

ocpi-tariffs/tests/integration.rs Show resolved Hide resolved
@bheylin bheylin merged commit 5749aeb into main Oct 7, 2024
10 of 12 checks passed
@bheylin bheylin deleted the update-lints branch October 7, 2024 08:51
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