fix: update snippet for clarity #224
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
Updated JSON snippet for YAML configuration. Signed-off-by: Awar Abdulkarim <[email protected]>
Updated the yaml.customTags section in the documentation. Signed-off-by: Awar Abdulkarim <[email protected]>
Contributor
Author
|
@mathieu-benoit made changes, hopefully the PR itself is ok. |
mathieu-benoit
requested changes
Oct 23, 2025
Contributor
mathieu-benoit
left a comment
mathieu-benoit
left a comment
There was a problem hiding this comment.
Thanks! Just left my review.
| "yaml.schemas": { | ||
| "https://raw.githubusercontent.com/score-spec/spec/main/score-v1b1.json": "score.yaml" | ||
| } | ||
| "yaml.customTags": [ |
Contributor
There was a problem hiding this comment.
Could you keep the snippet like it was, and instead of this change, after the screenshot, show this new snippet you propose (with a sentence like "This is how it should look like:"?
Contributor
Author
There was a problem hiding this comment.
Sorry I took so long to follow up, I updated the snippet like you asked and moved what I added to the end end of the text, please verify it's correct. 😄
Signed-off-by: Awar Abdulkarim <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Updated JSON snippet for YAML configuration.
Thank you for submitting this pull request! We appreciate you spending the time to work on these changes.
What is the motivation?
Clarifying the documentation to help the reader better understand where to insert the code snippet.
What does this change do?
This pull request adds and additional line to the code snippet which makes the placement of the original snippet more clear for the reader.
What is your testing strategy?
Followed instructions as documented and added the previous line to the snippet to make the placement understandable, no major changes.
Is this related to any issues?
fixes #223
Have you read the Contributing Guidelines?