IBM / nodejs-idb-connector

A JavaScript (Node.js) library for communicating with Db2 for IBM i, with support for queries, procedures, and much more. Uses traditional callback-style syntax
MIT License
37 stars 23 forks source link

execute docs incorrect #39

Closed abmusse closed 5 years ago

abmusse commented 6 years ago

Original report by Aaron Bartell (Bitbucket: aaronbartell, GitHub: aaronbartell).


The developerWork docs declare that both the result and the error can't both be declared as parameters on the callback.

But the code appears to support both result and error as parms to the callback. Here and here.

I propose the developerWorks docs be updated to reflect what the code currently supports. I don't have access to edit otherwise I would update it.

abmusse commented 5 years ago

Original comment by Xu Meng (Bitbucket: mengxumx, GitHub: dmabupt).


PR #6 is merged

abmusse commented 6 years ago

@aaronbartell PR #6 posted!

abmusse commented 6 years ago

Original comment by Aaron Bartell (Bitbucket: aaronbartell, GitHub: aaronbartell).


When I send out the PR could you review it?

Yeppers!

abmusse commented 6 years ago

@aaronbartell Sounds good! BTW I'm working on porting over the docs from developer works to markdown format so that it can be maintained here, then distributed as needed.

When I send out the PR could you review it?

abmusse commented 6 years ago

Original comment by Aaron Bartell (Bitbucket: aaronbartell, GitHub: aaronbartell).


That's correct.

abmusse commented 6 years ago

@aaronbartell I think I have access to update the docs.

Just to make sure you are proposing to change

Syntax 1:

execute(function Callback())

Syntax 2:

execute(function Callback(Out))

Syntax 3:

execute(function Callback(Error))

Into this:


Syntax:

execute(function Callback(Out, Error))