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

Match up documentation with that from std::collections::HashMap #57

Merged
merged 37 commits into from
Feb 4, 2020

Conversation

Arthamys
Copy link
Contributor

@Arthamys Arthamys commented Feb 3, 2020

This PR updates the documentation to match that of std::HashMap, along with simple examples.

The examples make use of flurry::epoch::pin(). I don't know if this is still desirable, or if the documentation should make use of HashMap::guard().

@jonhoo
Copy link
Owner

jonhoo commented Feb 3, 2020

This is great! I'll take a look through once I get the chance.

Two high-level comments:

  • We probably want to use @cuviper's new HashMapRef type in most of the examples, as it avoids the need to produce a guard manually. Just map.pin().get(key) for example. That should tidy up a lot of the example code I think.
  • When there are comments in the documentation, you need to enclose them in /* */ so that they do not show up in the actual documentation :)

@cuviper
Copy link
Collaborator

cuviper commented Feb 3, 2020

Oh, the joys of concurrent data structures -- "look ma, no mut!"

src/lib.rs Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Show resolved Hide resolved
src/map.rs Outdated Show resolved Hide resolved
src/map.rs Show resolved Hide resolved
src/map.rs Outdated Show resolved Hide resolved
src/map.rs Outdated Show resolved Hide resolved
src/map.rs Outdated Show resolved Hide resolved
src/map.rs Show resolved Hide resolved
src/map.rs Outdated Show resolved Hide resolved
src/map.rs Outdated Show resolved Hide resolved
src/map.rs Outdated Show resolved Hide resolved
@jonhoo
Copy link
Owner

jonhoo commented Feb 4, 2020

I'm working on fixing the failing address sanitizer stuff in #59

@jonhoo jonhoo merged commit 658e6b1 into jonhoo:master Feb 4, 2020
@jonhoo
Copy link
Owner

jonhoo commented Feb 4, 2020

Excellent, thank you so much!

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.

None yet

3 participants