Skip to content

Added documentation and made clippy a lot more annoying. #3

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

Merged
merged 17 commits into from
Jul 11, 2023

Conversation

nishaq503
Copy link
Contributor

@nishaq503 nishaq503 commented Jun 29, 2023

During the conversation in this issue, you suggested some work on the "jank" in the crate. In this PR, I have started to address some of this. For now, I have:

  • added documentation to pretty much everything that the lints warn about.
  • made clippy a lot more annoying.
  • addressed all clippy lints.

There are also some changes to function signatures as suggested by clippy. These include:

  • Removing the Box<dyn Fn<...>> types with the simpler fn(...) types.
  • Marking several const fn functions because they get evaluated at compile time, thus improving runtime performance.

I have ignored two clippy lints for the crate:

  • Module name repeated in struct name: I think this is too pedantic a lint and would be a massive API change that I don't think you would want for now. Perhaps later.
  • Functions with too many lines: I'm going to address this in a separate PR after spending some more time on the code.

@cmccomb
Copy link
Owner

cmccomb commented Jul 11, 2023

Excellent PR! Thank you so much for your work on this!

@cmccomb cmccomb merged commit 2e8cb55 into cmccomb:master Jul 11, 2023
@nishaq503 nishaq503 deleted the updates/docs-and-clippy branch July 11, 2023 21:43
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