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

Incorrect documentation for Tree#walk #1957

Open
JC3 opened this issue Dec 11, 2022 · 0 comments
Open

Incorrect documentation for Tree#walk #1957

JC3 opened this issue Dec 11, 2022 · 0 comments

Comments

@JC3
Copy link

JC3 commented Dec 11, 2022

The documentation for Tree#walk at https://www.nodegit.org/api/tree/#walk states that "entry" sends a Tree and "end" sends Array<Tree>.

This is not correct. "entry" actually appears to send TreeEntry, and "end" actually appears to send Array<TreeEntry>:

  • console.log of the event parameters confirms they are TreeEntry
  • The sent entity does not have any of the members that Tree has.

(As a side note, it would be super helpful if a note about not forgetting to call start() was also in this documentation, as well as a description of what the actual sent TreeEntrys are -- it's currently only in the tree walking example code.)

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

No branches or pull requests

1 participant