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

Improve wording, fix typos, add edition to Cargo.toml #20

Merged
merged 9 commits into from
Mar 11, 2024

Conversation

allan2
Copy link
Contributor

@allan2 allan2 commented Nov 20, 2021

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.

Copy link
Member

@Noratrieb Noratrieb left a 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
Comment on lines 11 to 12
Within `rustc`, it consistently outperforms FNV-based algorithms.
The collision rate is similar or slightly worse than FNV.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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.

Copy link
Contributor Author

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.

src/lib.rs Outdated Show resolved Hide resolved
@WaffleLapkin
Copy link
Member

Note that this PR has conflicts with master and requires a rebase.

Copy link
Member

@davidtwco davidtwco left a 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.

allan2 added 5 commits March 1, 2024 12:34
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
allan2 added 2 commits March 1, 2024 12:56
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.
@allan2
Copy link
Contributor Author

allan2 commented Mar 1, 2024

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.
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Nilstrieb <48135649+Nilstrieb@users.noreply.github.com>
@Noratrieb
Copy link
Member

thanks!

@Noratrieb Noratrieb merged commit b0df6d0 into rust-lang:master Mar 11, 2024
3 checks passed
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.

4 participants