Skip to content

Documentation : please specify the type of object_iter in write_pack. #23

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Open
ytrezq opened this issue Nov 10, 2015 · 1 comment
Open

Documentation : please specify the type of object_iter in write_pack. #23

ytrezq opened this issue Nov 10, 2015 · 1 comment
Labels
acknowledged

Comments

@ytrezq
Copy link

ytrezq commented Nov 10, 2015

object_iter is a list, but of what type ?
Ostream or Oinfo.

I think it would worth to precise it.
@ytrezq ytrezq changed the title Documentation : please specify the type of object_iter in write_pack ? Documentation : please specify the type of object_iter in write_pack. Nov 10, 2015
@Byron
Copy link
Member

Byron commented Nov 30, 2015

Indeed, thanks for letting me know.
I just reverse-engineered it by having a look at the tests. It seems that it expects an OPackStream compatible objects, as seen in the stream_iter() documentation.

I hope this answers your question, and would very much welcome a PR with documentation that would have helped you in the first place.

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
acknowledged
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Byron @ytrezq