Skip to content
This repository was archived by the owner on Mar 26, 2026. It is now read-only.
This repository was archived by the owner on Mar 26, 2026. It is now read-only.

@example Comments should refer to sample code #157

@sduskis

Description

@sduskis

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.docstype: cleanupAn internal cleanup or hygiene concern.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions