StephanvanSchaik / mmap-rs

A cross-platform and safe Rust API to create and manage memory mappings in the virtual address space of the calling process.
Apache License 2.0
61 stars 17 forks source link

Fmt+clippy #11

Closed hellow554 closed 1 year ago

hellow554 commented 1 year ago

My motivation was to add a simple #[derive(Debug)] to all public types. Then I noticed that the project was lacking a .gitignore file, was not formatted "properly" and last I fixed some clippy lints.

Feel free to comment or to discard the changes, I'll welcome your feedback :)

StephanvanSchaik commented 1 year ago

Thank you for your PR, I will gladly add these commits once the checks actually pass.

My motivation was to add a simple #[derive(Debug)] to all public types.

This is greatly appreciated, thank you!

lacking a .gitignore file

I am not a fan of .gitignore files, since they encourage people to use git add * rather than using git add -p :/ to look over everything they are about to commit and using git status to check if there are any non-tracked files to add. In addition, I have been involved in too many projects where people would also add their files specific to their IDE/editor to the .gitignore, turning it into a maintenance burden.

However, I figured out you are essentially adding the Rust template from the gitignore project, which at least does encourage people to use global .gitignore files for their editors/IDEs. So let's add this, since it is a template we likely won't have to touch in the future.

was not formatted "properly"

I haven't run cargo fmt recently, since I sometimes disagree with the formatting of tools (not necessarily cargo fmt), but it does look sensible here. It's probably good to adhere to a single standard as much as possible, in this case cargo fmt, as long as it doesn't do anything too weird.

last I fixed some clippy lints.

Thank you! These look good to me.

hellow554 commented 1 year ago

Thanks :)