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

Commit#getDiff callback is undocumented #1959

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

Commit#getDiff callback is undocumented #1959

JC3 opened this issue Dec 13, 2022 · 0 comments

Comments

@JC3
Copy link

JC3 commented Dec 13, 2022

The documentation at https://www.nodegit.org/api/commit/#getDiff does not document the callback for getDiff (the parameters it takes, etc.).

Additionally, the API doesn't seem to make sense: It takes a callback and returns a promise. It's unclear what the callback is for in the first place, as it seems to be an odd mix of promise-based and callback-based asynchronicity, which is typically either one or the other.

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