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

Include callback descriptions in docs #21

Open

johnhaley81 opened this issue Mar 25, 2015 · 1 comment

Collaborator

johnhaley81 commented Mar 25, 2015

Right now we don't have any callback definitions in the docs which is a pretty big hole and kind of confusing for a new user.

We'll need to decorate the callbacks in nodegit with descriptions as well for this to work.

Collaborator Author

johnhaley81 commented Mar 25, 2015

e.g. http://www.nodegit.org/api/remote_callbacks/ doesn't show what comes back in a TransferProgressCb so the user just has to test that method.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment