Skip to content

Start adding zero-copy docs #247

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

Merged
merged 7 commits into from
Jan 9, 2023
Merged

Conversation

CraftSpider
Copy link
Collaborator

@CraftSpider CraftSpider commented Jan 7, 2023

Adds documentation to all zero_copy items And one or two minor changes I couldn't resist while documenting

@CraftSpider
Copy link
Collaborator Author

Unrelated note: After this PR, definitely think it might be a good idea to pull Container, Seq, etc into their own module, to track these common 'container helpers'.

@CraftSpider CraftSpider marked this pull request as ready for review January 8, 2023 19:43
@CraftSpider
Copy link
Collaborator Author

Currently recover_with fails, and two docs are TODO. On the other hand, I think it may be worth to merge now and fix those things later, since this change is very prone to bitrot

@zesterer
Copy link
Owner

zesterer commented Jan 9, 2023

Do you think it's ready for merge?

@CraftSpider
Copy link
Collaborator Author

I'm going to add at least basic documentation to the two TODO ones quick, then I think so

@CraftSpider
Copy link
Collaborator Author

I'd call this PR ready to merge - there are one or two rough spots, but overall I think this improves the current state of zero-copy documentation.

@zesterer
Copy link
Owner

zesterer commented Jan 9, 2023

Thanks! This is a big step forward :)

@zesterer zesterer merged commit b524a69 into zesterer:zero-copy Jan 9, 2023
@CraftSpider CraftSpider deleted the zero-copy-doc branch March 2, 2023 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants