-
Notifications
You must be signed in to change notification settings - Fork 61
Closed
Labels
api: bigtableIssues related to the googleapis/nodejs-bigtable API.Issues related to the googleapis/nodejs-bigtable API.docstype: cleanupAn internal cleanup or hygiene concern.An internal cleanup or hygiene concern.
Description
nodejs-bigtable has @example comments that include code. This is error prone, since it's not compiled and may get obsolete. Instead of inline code, all @examples should refer to a sample file and a tag within it.
nodejs-spanner has a great examples of this. Here's one example (link):
/**
...
* @example <caption>include:samples/batch.js</caption>
* region_tag:spanner_batch_client
*/
Metadata
Metadata
Assignees
Labels
api: bigtableIssues related to the googleapis/nodejs-bigtable API.Issues related to the googleapis/nodejs-bigtable API.docstype: cleanupAn internal cleanup or hygiene concern.An internal cleanup or hygiene concern.