-
Notifications
You must be signed in to change notification settings - Fork 468
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
Add initial docs to crossbeam-skiplist #535
Conversation
This is amazing work <3
The idea behind |
|
Hi @caelunshun! Any updates on this? (It seems that there is still one checkbox left.) If you don't have the bandwidth to work on the remaining things, I'd like to leave them to follow-up PR (by me or someone) and merge this to avoid conflicts. BTW, this looks great. Thanks for working on this! |
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.
Thanks @caelunshun for working on this!
I added the remaining things to the checklist of the tracking issue (#635).
bors r+
Build succeeded: |
653: Use intra-doc links r=taiki-e a=taiki-e follow-up #535 Co-authored-by: Taiki Endo <[email protected]>
657: impl Deref for set::Entry r=Vtec234 a=taiki-e *This originally suggested by @caelunshun in #535 (comment) cc #635 Co-authored-by: Taiki Endo <[email protected]>
As per #503 (comment), I'm writing the docs for
crossbeam-skiplist
.Checklist:
SkipMap
SkipSet
I also have some thoughts about the API:
Entry
's name is misleading; it's not the same as the standard library's map entry API. A name likeRef
might be more suitable, to align withRefCell
.set::Entry
could implementDeref<Target=T>
for convenience.SkipList
struct is exposed, though I'm not sure if it belongs in the public API.