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

A few improvement ideas #7

Merged
merged 1 commit into from
Apr 2, 2024
Merged

Conversation

nyurik
Copy link
Contributor

@nyurik nyurik commented Mar 31, 2024

I was reviewing code, and just made a bunch of minor fixes. I wasn't sure where you want to take this code next, so its one PR - but I could remove any parts that you think are not improving.

  • Fix README crates link to point to crates.io, and add a few more status tags.
  • Migrate to 2021 edition
  • A few cargo fmt and cargo clippy changes
    • Use cm::Ordering to do the compare+match
  • A few minor CI improvements to catch those
  • Move main example to README.md, and made README.md included into the code as documentation - this way both GitHub and cargo.rs should the same documentation.
  • Make README examples runnable/testable (now part of cargo test)

TODO

  • I am not sure homepage should link to lib.rs -- perhaps consider removing it?

@nyurik nyurik force-pushed the lint-ideas branch 2 times, most recently from 88afb18 to e5abdf0 Compare March 31, 2024 08:06
run: cargo test --verbose
- uses: actions/checkout@v2
- name: Ensure proper formatting (use `cargo fmt` to fix)
run: cargo fmt --all -- --check
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please don't force formatting. Rustfmt is not good enough to apply unconditionally, and it's a bad experience for people submitting PRs to have them rejected only due to a space or something trivial that could be fixed afterwards.

src/diff.rs Show resolved Hide resolved
I was reviewing code, and just made a bunch of minor fixes. I wasn't sure where you want to take this code next, so its one PR - but I could remove any parts that you think are not improving.

* Fix README crates link to point to crates.io, and add a few more status tags.
* Migrate to 2021 edition
* A few `cargo fmt` and `cargo clippy` changes
  * Use cm::Ordering to do the compare+match
* A few minor CI improvements to catch those
* Move main example to README.md, and made README.md included into the code as documentation - this way both GitHub and cargo.rs should the same documentation.
* Make README examples runnable/testable (now part of `cargo test`)

* I am not sure homepage should link to lib.rs -- perhaps consider removing it?
@nyurik
Copy link
Contributor Author

nyurik commented Apr 1, 2024

thx, updated

@kornelski kornelski merged commit 77d9bf7 into space-wizards:master Apr 2, 2024
1 check passed
@nyurik nyurik deleted the lint-ideas branch April 5, 2024 08:46
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