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

chore(cloud-rad): add code fencing for TSDoc#1679

Merged
shaffeeullah merged 2 commits intomainfrom
fhinkel-code-fenzing
Oct 27, 2021
Merged

chore(cloud-rad): add code fencing for TSDoc#1679
shaffeeullah merged 2 commits intomainfrom
fhinkel-code-fenzing

Conversation

@fhinkel
Copy link
Copy Markdown
Contributor

@fhinkel fhinkel commented Oct 26, 2021

Code examples need code fencing around them to distingish from
rich text for TSDoc.

Internally b/179483748

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

@fhinkel fhinkel requested review from a team October 26, 2021 15:35
@google-cla google-cla Bot added the cla: yes This human has signed the Contributor License Agreement. label Oct 26, 2021
@shaffeeullah
Copy link
Copy Markdown
Contributor

Will this break the way this documentation is rendered on googleapis.dev?

@fhinkel fhinkel changed the title chore(cloud-rad): add code fenzing for TSDoc chore(cloud-rad): add code fencing for TSDoc Oct 26, 2021
@product-auto-label product-auto-label Bot added the api: storage Issues related to the googleapis/nodejs-storage API. label Oct 27, 2021
@fhinkel
Copy link
Copy Markdown
Contributor Author

fhinkel commented Oct 27, 2021

Since googleapis.dev understands markdown, it shouldn't be a problem.

@shaffeeullah shaffeeullah merged commit 8fcb485 into main Oct 27, 2021
@shaffeeullah shaffeeullah deleted the fhinkel-code-fenzing branch October 27, 2021 14:59
fhinkel added a commit that referenced this pull request Oct 28, 2021
Instead of `<caption>` use rich text for examples.

See #1679
shaffeeullah pushed a commit that referenced this pull request Oct 29, 2021
Instead of `<caption>` use rich text for examples.

See #1679
sofisl pushed a commit to googleapis/google-cloud-node that referenced this pull request Feb 25, 2026
Instead of `<caption>` use rich text for examples.

See googleapis/nodejs-storage#1679
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants