add rustdoc and clippy to github workflow - #618
Closed
hellow554 wants to merge 11 commits into
Closed
Conversation
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.
This commit is quite a mouth full and I'm can understand if you want me to split this into smaller chunks.
Let me start explain it commit by commit.
First I created a clippy toml with the msrv set to 1.36.0, which is the version used in the github workflow.
Next I either fixed all the linted lines, or added a allow with a comment to it.
I did the same for all the tests.
Next I saw, that there is currently a rustfmt which skips the complete source base, based on a commit two years ago: 641671e
"Temporarily disable" 😉
I then reformatted the whole codebase, which might break some PRs but they should be able to rebase it but just using
cargo fmteasily.Next, I fixed two warnings. One stray ``` and the other one being changed in rust-lang/rust#96676 where you have to specify a macro link.
Last, but not least, I added
rustfmtrustdocandclippyto theci.ymlto enable them by default on PRs.Feel free to comment whatever you think. I try to answer or change it :)
Thanks for the awesome crate :)