Incorrect JSDoc for a variety of methods #345
Labels
api: spanner
Issues related to the googleapis/nodejs-spanner API.
type: docs
Improvement to the documentation for an API.
I found some discrepancies between implementation and documentation when I've tried to generate a
.d.ts
file based on JSDoc with @otris/jsdoc-tsd npm module.Here are some of the issues:
object
should start with capital O for metadata argumentstring
orobject
as the first argument, so probably there should be a separate@typedef
for thatobject
, but I'm not sure.Error
instead oferror
andDate
instead ofdate
, unless I've missed typedefs for those types.Environment details
@google-cloud/spanner
version: 2.0.0Steps to reproduce
Following these steps will guarantee the quickest resolution possible.
Map the errors returned by TypeScript compiler to the actual code and fix the documentation.
There is a way to configure TypeScript compiler to check JavaScript files (it will also pick up JSDoc comments as type annotations), but that could result in too much noise if you only want to check that the documentation is valid.
I'm pretty sure there are some other means to validate JSDoc as well.
Thanks!
PS.: I'd be glad to submit a PR(s) to fix some of this issues.
The text was updated successfully, but these errors were encountered: