Skip to content

FR: Remove inline docs in client.ts, add @example tag #592

@sofisl

Description

@sofisl

See googleapis/gapic-generator-typescript#981

We're not going to include:

 *
 * @example <caption>include:samples/generated/{{api.naming.version}}/{{service.name.toSnakeCase()}}.{{method.name.toSnakeCase()}}.js</caption>
 * region_tag:{{ api.naming.productName.toSnakeCase() }}_{{ method.name.toSnakeCase() }}_sample
 *

in templates/typescript_gapic/src/$version/$service_client.ts.njk

because it is not yet fully functional in cloud rad.

When it becomes functional, we will add this region tag, and delete the current @example tag that just includes inline samples).

@fhinkel to notify when this is ready.

Metadata

Metadata

Assignees

Labels

priority: p3Desirable enhancement or fix. May not be included in next release.type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions