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

fix(cloud-rad): move comments for TSDoc#1509

Merged
gcf-merge-on-green[bot] merged 1 commit intomainfrom
fhinkel-move-comment
Nov 8, 2021
Merged

fix(cloud-rad): move comments for TSDoc#1509
gcf-merge-on-green[bot] merged 1 commit intomainfrom
fhinkel-move-comment

Conversation

@fhinkel
Copy link
Copy Markdown
Contributor

@fhinkel fhinkel commented Nov 5, 2021

As we move our ref docs to cloud.google.com, we rely on TSDoc rather JSDoc.

TSDoc expects comments before the first overloaded function, we
currently have those on the last function. Those comments don't make
it into the d.ts files. We need to move comments to the first
overloaded function rather than the last one.

Internally b/190631834

Script used: https://github.com/fhinkel/cloud-rad-script/blob/main/moveComments.js

@fhinkel fhinkel requested review from a team November 5, 2021 17:06
@product-auto-label product-auto-label bot added the api: spanner Issues related to the googleapis/nodejs-spanner API. label Nov 5, 2021
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Nov 5, 2021
fhinkel added a commit to fhinkel/cloud-rad-script that referenced this pull request Nov 5, 2021
@fhinkel fhinkel added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 5, 2021
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 5, 2021
@fhinkel fhinkel added the automerge Merge the pull request once unit tests and other checks pass. label Nov 5, 2021
@fhinkel fhinkel force-pushed the fhinkel-move-comment branch from adf23e4 to a261b83 Compare November 5, 2021 22:05
@fhinkel fhinkel added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 5, 2021
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 5, 2021
@fhinkel fhinkel removed the automerge Merge the pull request once unit tests and other checks pass. label Nov 5, 2021
As we move our ref docs to cloud.google.com, we rely on TSDoc rather JSDoc.

TSDoc expects comments before the first overloaded function, we
currently have those on the last function. Those comments don't make
it into the d.ts files. We need to move comments to the first
overloaded function rather than the last one.

Internally b/190631834
@fhinkel fhinkel force-pushed the fhinkel-move-comment branch from a261b83 to 1319bc5 Compare November 5, 2021 23:45
@fhinkel fhinkel changed the title chore(cloud-rad): move comments for TSDoc fix(cloud-rad): move comments for TSDoc Nov 6, 2021
@bcoe bcoe added the automerge Merge the pull request once unit tests and other checks pass. label Nov 8, 2021
@skuruppu skuruppu added automerge Merge the pull request once unit tests and other checks pass. and removed automerge Merge the pull request once unit tests and other checks pass. labels Nov 8, 2021
@gcf-merge-on-green gcf-merge-on-green bot merged commit 1c49922 into main Nov 8, 2021
@gcf-merge-on-green gcf-merge-on-green bot deleted the fhinkel-move-comment branch November 8, 2021 23:04
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Nov 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

api: spanner Issues related to the googleapis/nodejs-spanner API. cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants