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

no_std, std-compatible type aliases, docs #35

Merged
merged 12 commits into from
Dec 25, 2023
Merged

Conversation

virtualritz
Copy link
Contributor

  • Added no_std support.
  • Removed the Gx prfix from the convenience type aliases and added HashMapExt compatibility trait.
  • Moved major parts of README to lib.rs.
  • Added support for auto-generating main part of README with cargo rdme.
  • Various grammar, spelling and style fixes to docs.

@virtualritz
Copy link
Contributor Author

Will fix the failing tests asap.

@ogxd
Copy link
Owner

ogxd commented Dec 23, 2023

Hi @virtualritz, just letting you know that I haven't forgotten your PR. I would like to merge a quite substantial refactoring first and then I'll rebase your PR on it

@virtualritz
Copy link
Contributor Author

I didn't think you did, I saw you where very busy in other branches. 😁
Looking forward to all the stuff you did making it into a release soon!

@ogxd ogxd changed the base branch from main to no_std December 25, 2023 20:55
@ogxd
Copy link
Owner

ogxd commented Dec 25, 2023

Hi @virtualritz,
I just had a look at the PR.
I can't approve it as such as it mixes too many topics.
Here are all the topics that I think deserve each their own issue/PR:

  • no_std (std feature + cfg flags to exclude hashset/hashmap for no_std)
  • Renaming of gxhash:GxHashSet to gxhash::HashSet (and GxHashMap)
  • Introduction of cargo rdme
  • Automatic formatting with cargo fmt

I'll rebase this branch on latest main commit and extract two commits for the two first points

@ogxd ogxd merged commit 49a85c0 into ogxd:no_std Dec 25, 2023
1 check passed
ogxd added a commit that referenced this pull request Dec 25, 2023
* Added `Clone` and `Debug` traits to `GxHasher` and `GxBuildHasher`.

* Updated deps.

* Made clippy (almost) happy.

* rustfmt.

* Added no_std compatibility, removed `Gx` prefix from type aliases, `cargo rdme` support, README spelling, grammar, etc.

* `cargo rdme` options

* Added cargo features section in docs.

* Fixed tests and doc tests.

* Missing line-breaks.

---------

Co-authored-by: Olivier Giniaux <[email protected]>
ogxd added a commit that referenced this pull request Dec 25, 2023
* Added `Clone` and `Debug` traits to `GxHasher` and `GxBuildHasher`.

* Updated deps.

* Made clippy (almost) happy.

* rustfmt.

* Added no_std compatibility, removed `Gx` prefix from type aliases, `cargo rdme` support, README spelling, grammar, etc.

* `cargo rdme` options

* Added cargo features section in docs.

* Fixed tests and doc tests.

* Missing line-breaks.

---------

Co-authored-by: Olivier Giniaux <[email protected]>
ogxd added a commit that referenced this pull request Dec 25, 2023
* Added `Clone` and `Debug` traits to `GxHasher` and `GxBuildHasher`.

* Updated deps.

* Made clippy (almost) happy.

* rustfmt.

* Added no_std compatibility, removed `Gx` prefix from type aliases, `cargo rdme` support, README spelling, grammar, etc.

* `cargo rdme` options

* Added cargo features section in docs.

* Fixed tests and doc tests.

* Missing line-breaks.

---------

Co-authored-by: Olivier Giniaux <[email protected]>
@ogxd
Copy link
Owner

ogxd commented Dec 25, 2023

Here I have extracted two PRs from this one:

Don't hesitate to leave comments I'll keep these PRs open for a few days before merging

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