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.

Sign up for GitHub

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

Jump to bottom

irmin-pack.unix: document functions that use a buffer as input #1972

Open
metanivek opened this issue Jul 7, 2022 · 0 comments
Open

irmin-pack.unix: document functions that use a buffer as input #1972

metanivek opened this issue Jul 7, 2022 · 0 comments
Labels
type/doc Change documentation

Comments

@metanivek
Copy link
Member

metanivek commented Jul 7, 2022 •
edited

It would be nice to document that these functions do not retain ownership of the buffer so that

  1. future maintainers have implementation details documented
  2. we can confidently use Bytes.unsafe_to_string

See review comments in #1970 for context.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type/doc Change documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@metanivek