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 examples #57

Closed
lyrm opened this issue Feb 23, 2023 · 3 comments · May be fixed by #59
Closed

Add examples #57

lyrm opened this issue Feb 23, 2023 · 3 comments · May be fixed by #59

Comments

@lyrm
Copy link
Collaborator

lyrm commented Feb 23, 2023

This library is currently lacking documentation. A good step will be to add simple examples (with multiple domains) for each data structures that could serve as tutorial.

More complex examples would also be great, in particular for testing purposes.

@nikochiko
Copy link

nikochiko commented Feb 28, 2023

Hey I'd like to take this up.
I've been going through the MS queue paper and I have a fair idea of that and other lockfree structures now.

Where should the examples go? The README or a separate examples/ directory?

@Sudha247
Copy link
Collaborator

Sudha247 commented Mar 1, 2023

Hey @nikochiko, thanks for your interest! MSQueue is a good one to start with. The examples can go to a new examples directory.

@bartoszmodelski bartoszmodelski linked a pull request May 10, 2023 that will close this issue
@lyrm
Copy link
Collaborator Author

lyrm commented Nov 28, 2024

This has been done in recent PR for all data structures.

@lyrm lyrm closed this as completed Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants