docs(core): correct example code block formatting#3601
Merged
marvinhagemeister merged 1 commit intoNov 4, 2025
Conversation
Contributor
Author
|
Hmm... giving titles to examples seems to break indentation of examples when using VSCode, which is kinda bad... microsoft/TypeScript#43955. Which is more important, nicer documentation rendering on JSR, or correct rendering of tooltip in VSCode? |
marvinhagemeister
approved these changes
Nov 4, 2025
Contributor
marvinhagemeister
left a comment
There was a problem hiding this comment.
LGTM, we should make our LSP better to handle example code blocks.
This file contains hidden or 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
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.
The example for the CSP middleware looks a bit broken currently on JSR, due to the
@examplemarkdown is not wrapped in a code block.Changes
```ts@example- "Basic usage" - To avoid the example being labeled as "Example1" on JSR