fix: use correct syntax for inline link tags #1328
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Google Cloud uses [API Extractor](https://api-extractor.com/) and [API Documenter](https://api-extractor.com/pages/setup/generating_docs/) to generate API docs for Node.js client libraries. These tools can't resolve links that are formatted like the following example: ``` [Widget]{@link google.someapi.v1.Widget} ``` However, links that use [TSDoc notation](https://api-extractor.com/pages/tsdoc/tag_link/) work just fine: ``` {@link google.someapi.v1.Widget | Widget} ``` So I've updated the templates to use the latter syntax.
Hopefully that's the last of them.
alexander-fenster
added
the
automerge
gcf-merge-on-green
bot
removed
the
automerge
gcf-merge-on-green bot
pushed a commit
that referenced
this pull request
Feb 13, 2023
🤖 I have created a release *beep* *boop* --- ## [3.0.3](https://togithub.com/googleapis/gapic-generator-typescript/compare/v3.0.2...v3.0.3) (2023-02-13) ### Bug Fixes * **deps:** Update dependency google-gax to ^3.5.7 ([#1323](https://togithub.com/googleapis/gapic-generator-typescript/issues/1323)) ([178dcf0](https://togithub.com/googleapis/gapic-generator-typescript/commit/178dcf039caa7bedf24e779e9f829effae11de81)) * Do not fail if service yaml does not list any apis ([#1325](https://togithub.com/googleapis/gapic-generator-typescript/issues/1325)) ([28a980a](https://togithub.com/googleapis/gapic-generator-typescript/commit/28a980a42e7d49d3b90b0cf1391e3b6f8348547e)) * Make error message more visible ([#1330](https://togithub.com/googleapis/gapic-generator-typescript/issues/1330)) ([9c53c64](https://togithub.com/googleapis/gapic-generator-typescript/commit/9c53c648871718585a015566e940f4267bc4297b)) * Use correct syntax for inline link tags ([#1328](https://togithub.com/googleapis/gapic-generator-typescript/issues/1328)) ([801a54d](https://togithub.com/googleapis/gapic-generator-typescript/commit/801a54d450c1b770593f54731161093009626d1e)) * Use the official rules_ts ([#1329](https://togithub.com/googleapis/gapic-generator-typescript/issues/1329)) ([4aef706](https://togithub.com/googleapis/gapic-generator-typescript/commit/4aef70624d39b904000aa201100c87dfd5b8ea05)) --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Google Cloud uses API Extractor and API Documenter to generate API docs for Node.js client libraries. These tools can't resolve links that are formatted like the following example:
However, links that use TSDoc notation work just fine:
So I've updated the templates to use the latter syntax.
@dansaadati FYI