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

chores: refactor + cleanup #52

Merged
merged 10 commits into from
May 10, 2024
Merged

chores: refactor + cleanup #52

merged 10 commits into from
May 10, 2024

Conversation

Autoparallel
Copy link
Contributor

@Autoparallel Autoparallel commented May 9, 2024

Working to:

  • reduce SLOC
  • reduce redundancies
  • generalize some things
  • fix some bugs
  • make things easier to use
  • Restructure crate
  • Renames
  • Add cargo docs

Added dev-dependencies:

  • rstest.
    • Allows for building fixtures and procedural cases (and more) for your tests.
    • Allows you to treat test functions as real function calls which let's you see how the borrow checker will ruin your life a bit more clearly too.
    • An addition to the test harness that I really want to try out. I think it can likely be powerful especially as there is more mocking and cases to be done.
    • Make sure your Rust analyzer is set to expand macros!
    • Used in the polynomial module (although it may be a bit overkill).
  • pretty_assertions:
    • Richer diffs in your assertions so that you may more easily see what is failing when one is hit.
    • Mildly nice devex tool for writing tests. Nothing crazy.

@Autoparallel Autoparallel force-pushed the chore/refactor-cleanup branch from 60dbadb to 5fa09c4 Compare May 9, 2024 18:52
Copy link
Contributor

@0xJepsen 0xJepsen left a comment

Choose a reason for hiding this comment

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

Very clean PR nice work, well documented too

Copy link
Contributor

@devloper devloper left a comment

Choose a reason for hiding this comment

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

scrub a dub dub, nice cleanup!

@Autoparallel
Copy link
Contributor Author

I could add the crate attribute to enforce docs or throw clippy warning. I think this would be good so we have to document everything including crate/module level and not just body level.

@0xJepsen 0xJepsen merged commit aff73f7 into main May 10, 2024
4 checks passed
@github-actions github-actions bot mentioned this pull request Jul 1, 2024
@lonerapier lonerapier deleted the chore/refactor-cleanup branch January 18, 2025 07:03
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.

3 participants