lockfree icon indicating copy to clipboard operation
lockfree copied to clipboard

There are no 'How it works' sections in data structure READMEs

Open DNedic opened this issue 2 years ago • 2 comments

In order to help both users, curious bystanders or people looking to contribute, we should have sections explaining how data structures work under the hood, prefferably with diagrams included.

For data structures that are widely used and documented, like the spsc::Queue, it might not be necessary.

DNedic avatar Dec 30 '23 01:12 DNedic

Shall I help you out with that? Please assign this issue to me. I'm forking your repo.

gmottajr avatar Jan 01 '24 18:01 gmottajr

Hello @gmottajr , thank you for the offer, I would be glad to get any help!

I have already prepared some drafts for the Bipartite Buffer, so you might want to look at that when I push it, and do documentation for other data structures.

DNedic avatar Jan 02 '24 01:01 DNedic