-
Notifications
You must be signed in to change notification settings - Fork 50
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
Improve wording, fix typos, add edition to Cargo.toml
#20
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the PR and sorry for the, uh, very long review time^^. Two small changes, then we can merge it.
also cc @wesleywiser / @davidtwco since this touches something related to licensing, but it looks fine to me
README.md
Outdated
Within `rustc`, it consistently outperforms FNV-based algorithms. | ||
The collision rate is similar or slightly worse than FNV. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Within `rustc`, it consistently outperforms FNV-based algorithms. | |
The collision rate is similar or slightly worse than FNV. | |
Within `rustc`, it consistently outperforms every other tested algorithm (for example, FNV). | |
The collision rate is similar or slightly worse than others. |
There have been a lot of benchmarks and fxhash has always come out on the winning side.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed. "(such as FNV)" sounds more suitable to me.
Note that this PR has conflicts with master and requires a rebase. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
License changes seem fine 👍 Haven't looked at the rest.
This change is to be consistent with rust-lang/rust. Their change was made in October 2019. The PR over there: [Replace code of conduct with link #65141](rust-lang/rust#65141)
Edition added as 2018. 2015 throws errors. Version is not changed.
This change is to be consistent with rust-lang/rust. Their change was made in January 2020. The PR over there: [Remove appendix from LICENCE-APACHE](rust-lang/rust#67734)
Language is updated to be consistent with rust-lang/rust, particularly the std::collections::HashMap page. Changes: - newline in the example after `use` statement for clarity - fix typo in type definition for `FxHashSet` (previously said it was for a hashmap) - wording and phrasing - consistent language between `README.md` and the docs
Incorporates Nilstrieb's suggestion in the review for PR rust-lang#20
Removes the license header in *lib.rs* to match up with the main repo.
I rebased to the latest master and incorporated both suggestions. Ready for review or merging :) |
I missed this when fixing conflicts. This matches the `FxHashMap` description.
Co-authored-by: Nilstrieb <48135649+Nilstrieb@users.noreply.github.com>
thanks! |
All doc changes, except for adding version to
Cargo.toml
and updating the crate description.Language is changed to be consistent with rust-lang/rust.
See commit messages for more details.