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

Readme Documentation Draft -1 #383

Merged
merged 2 commits into from
Aug 12, 2024
Merged

Readme Documentation Draft -1 #383

merged 2 commits into from
Aug 12, 2024

Conversation

abhayporwals
Copy link
Collaborator

@abhayporwals abhayporwals commented Jul 18, 2024

I created a draft of the developer documentation for the library.

Fixes #347

@abhayporwals abhayporwals added the gsoc24 Google Summer of Code 2024 label Jul 18, 2024
@abhayporwals abhayporwals self-assigned this Jul 18, 2024
Copy link
Member

@hoch hoch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this and it looks great in general! I have a few comments to fix.

Copy link
Member

@hoch hoch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hoch hoch requested a review from mjwilson-google July 23, 2024 16:21
@hoch
Copy link
Member

hoch commented Jul 23, 2024

This looks good to me, but I would like to get a review from @mjwilson-google as well.

@abhayporwals
Copy link
Collaborator Author

This looks good to me, but I would like to get a review from @mjwilson-google as well.

Yeah sure 🙂

Copy link
Collaborator

@mjwilson-google mjwilson-google left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this looks good with small nits (up to you if you want to change them or not).

Once the npm package is ready the installation instructions can be updated to include that method as well.

@hoch hoch merged commit c85c633 into main Aug 12, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gsoc24 Google Summer of Code 2024
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve RingBuffer
3 participants