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

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

Open
DNedic opened this issue Dec 30, 2023 · 2 comments
Open

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

DNedic opened this issue Dec 30, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@DNedic
Copy link
Owner

DNedic commented Dec 30, 2023

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 DNedic added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Dec 30, 2023
@gmottajr
Copy link

gmottajr commented Jan 1, 2024

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

@DNedic
Copy link
Owner Author

DNedic commented Jan 2, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants