Improve codefence in JSON snippet #9973
Merged
Conversation
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
martincostello
requested review from
rbhanda,
leecow and
victorisr
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR improves the syntax highlighting and rendering of a JSON code block in the SDK documentation by changing the language identifier from json to jsonc to properly handle comments within the JSON snippet.
- Changes the code fence language from
jsontojsoncto prevent syntax error rendering when comments are present in the JSON
Merged
jongalloway
approved these changes
Aug 8, 2025
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.
Stops the comment being rendered like a syntax error.
#9830 (comment)