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

Add initial docs to crossbeam-skiplist #535

Merged
merged 5 commits into from
Feb 13, 2021
Merged

Conversation

caelunshun
Copy link
Contributor

@caelunshun caelunshun commented Jun 26, 2020

As per #503 (comment), I'm writing the docs for crossbeam-skiplist.

Checklist:

  • Crate-level docs
  • Docs for SkipMap
  • Docs for 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 like Ref might be more suitable, to align with RefCell.
  • set::Entry could implement Deref<Target=T> for convenience.
  • I see the base SkipList struct is exposed, though I'm not sure if it belongs in the public API.

@ghost
Copy link

ghost commented Jun 29, 2020

This is amazing work <3

Entry is a lot like the new linked list Cursor: https://doc.rust-lang.org/nightly/alloc/collections/linked_list/struct.Cursor.html

The idea behind SkipList is that it is a low-level API for people who want more control than what SkipSet and SkipMap offer. I believe @Amanieu is using it.

@Amanieu
Copy link
Contributor

Amanieu commented Jun 29, 2020

SkipList is exposed because it is usable in no_std code. It does not rely on the thread-local Collector (since no_std doesn't have TLS).

@taiki-e
Copy link
Member

taiki-e commented Jan 2, 2021

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!

@taiki-e taiki-e added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author label Jan 2, 2021
Copy link
Member

@taiki-e taiki-e left a 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+

@taiki-e taiki-e removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author label Feb 13, 2021
@bors
Copy link
Contributor

bors bot commented Feb 13, 2021

Build succeeded:

@bors bors bot merged commit 64506d5 into crossbeam-rs:master Feb 13, 2021
@taiki-e taiki-e mentioned this pull request Feb 13, 2021
bors bot added a commit that referenced this pull request Feb 13, 2021
653: Use intra-doc links r=taiki-e a=taiki-e

follow-up #535

Co-authored-by: Taiki Endo <te316e89@gmail.com>
bors bot added a commit that referenced this pull request Feb 13, 2021
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 <te316e89@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

3 participants