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

Code formatting and documentation #149

Merged
merged 21 commits into from
May 12, 2024

Conversation

Matthieu-LAURENT39
Copy link
Contributor

@Matthieu-LAURENT39 Matthieu-LAURENT39 commented May 11, 2024

This PR aims to make the code easier to work on by formatting the code with cargo fmt, refactoring and cleaning up some of the code, and adding comments to document the code.

For the formatting, i manually went through and verified every change.
I kept the formatting commit separate on purpose, so if you don't like it i can rebase the PR without them.

@Matthieu-LAURENT39 Matthieu-LAURENT39 marked this pull request as draft May 11, 2024 16:12
@Matthieu-LAURENT39
Copy link
Contributor Author

I think that's about all i can clean up and document.
I rather not comment too much on the parts i don't understand well, better to have no comments that wrong comments.

@Matthieu-LAURENT39 Matthieu-LAURENT39 marked this pull request as ready for review May 11, 2024 18:34
assert_eq!(filter.only_dir, true);
assert_eq!(filter.negate, false);
assert!(filter.only_dir);
assert!(filter.negate);
Copy link
Owner

Choose a reason for hiding this comment

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

Looks like this assertion is the opposite from the original one. Haven't that affected the tests at all?

Copy link
Contributor Author

@Matthieu-LAURENT39 Matthieu-LAURENT39 May 12, 2024

Choose a reason for hiding this comment

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

It sure did. I ran cargo test on linux, so i didn't catch that since it's a windows test 😓
I was waiting to see the workflow results for the windows tests to see if i hadn't screwed anything up there

@jhspetersson jhspetersson merged commit ab3f2ca into jhspetersson:master May 12, 2024
3 checks passed
@jhspetersson
Copy link
Owner

Hooray! Great job, really! Thank you so much. Merged with a deep feeling of satisfaction :)

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