Render JSDoc examples as typescript code #234143
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
|
@microsoft-github-policy-service agree |
mjbvz
reviewed
Nov 18, 2024
extensions/typescript-language-features/src/languageFeatures/util/textRendering.ts
Outdated
Show resolved
Hide resolved
ribru17
force-pushed
the
example_ts_rendering
branch
from
4c3e3ab
to
1f025e6
Compare
joyceerhl
previously approved these changes
Nov 20, 2024
rzhao271
previously approved these changes
Nov 20, 2024
|
@ribru17 Looks like some unit tests are failing. Can you please take a look https://dev.azure.com/vscode/VSCode/_build/results?buildId=137571&view=logs&j=a8a6689c-5a84-59c0-482a-7dd9f21eb2d8&t=6a176377-a7f9-5885-a44e-71e6c3076321&l=1215 |
Currently `@example` produces Markdown code blocks for code examples, but they are not annotated with a programming language. This commit annotates those code blocks as `typescript`, allowing for better highlighting for JS/TS when using Markdown renderers that recognize these languages.
ribru17
force-pushed
the
example_ts_rendering
branch
from
1f025e6
to
75ee4fe
Compare
|
Oops thanks for lmk! Should be fixed now. |
rzhao271
approved these changes
Nov 22, 2024
bhavyaus
approved these changes
Nov 22, 2024
osortega
pushed a commit
that referenced
this pull request
Nov 26, 2024
Currently `@example` produces Markdown code blocks for code examples, but they are not annotated with a programming language. This commit annotates those code blocks as `typescript`, allowing for better highlighting for JS/TS when using Markdown renderers that recognize these languages.
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.
Currently
@exampleproduces Markdown code blocks for code examples, but they are not annotated with a programming language. This commit annotates those code blocks astypescript, allowing for better highlighting for JS/TS when using Markdown renderers that recognize these languages.See this related PR: typescript-language-server/typescript-language-server#918
Fixes #234142