tedious icon indicating copy to clipboard operation
tedious copied to clipboard

Documentation issues

Open akc42 opened this issue 4 years ago • 2 comments

As I said in a previous issue, I have just upgraded from version 2.0.1 to 12.2.0

I was trying to use the documentation to make sure I included all the correct changes mentioned in the release notes. I noticed the following problems

  • At the very head of the API Connection section - there is no mention of the connection.connect() call. The example below in new Connection() does show it being used.
  • the metaData returned in the ReturnValue event does not include colName - although this might be because it was a spurious event (see other issue I raised #1344)

akc42 avatar Sep 20 '21 12:09 akc42

  • At the very head of the API Connection section - there is no mention of the connection.connect() call. The example below in new Connection() does show it being used.

I'll see if we can get that fixed - you're also welcome to open a PR for this. 👍

  • the metaData returned in the ReturnValue event does not include colName

I don't think there is supposed to be a colName value in this case, because there is no actual column - it's coming from a "output" parameter.

arthurschreiber avatar Sep 20 '21 21:09 arthurschreiber

I don't think there is supposed to be a colName value in this case, because there is no actual column - it's coming from a "output" parameter.

Precisely - but the documentation points to a description of the metadata which includes column name

akc42 avatar Sep 22 '21 14:09 akc42