docs: fix comment syntax in YAML/JSON code blocks#411
Merged
Conversation
Replace invalid `//` comments with `#` in YAML examples, and move inline comments out of JSON strings into proper YAML-level `#` comments.
oilbeater
approved these changes
Jul 4, 2026
Contributor
|
Thanks! @cheese |
1 task
oilbeater
added a commit
that referenced
this pull request
Jul 4, 2026
Replace invalid `//` comment with `#` in the kubectl output bash block, matching the block's own convention and the fix in #411 which missed this line. Signed-off-by: Mengxin Liu <liumengxinfly@gmail.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
oilbeater
pushed a commit
that referenced
this pull request
Jul 4, 2026
Replace invalid `//` comments with `#` in YAML examples, and move inline comments out of JSON strings into proper YAML-level `#` comments. (cherry picked from commit 6b7a35f)
oilbeater
added a commit
that referenced
this pull request
Jul 4, 2026
Replace invalid `//` comment with `#` in the kubectl output bash block, matching the block's own convention and the fix in #411 which missed this line. Signed-off-by: Mengxin Liu <liumengxinfly@gmail.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com> (cherry picked from commit 2294c4f)
oilbeater
pushed a commit
that referenced
this pull request
Jul 4, 2026
Replace invalid `//` comments with `#` in YAML examples, and move inline comments out of JSON strings into proper YAML-level `#` comments. (cherry picked from commit 6b7a35f)
oilbeater
added a commit
that referenced
this pull request
Jul 4, 2026
Replace invalid `//` comment with `#` in the kubectl output bash block, matching the block's own convention and the fix in #411 which missed this line. Signed-off-by: Mengxin Liu <liumengxinfly@gmail.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com> (cherry picked from commit 2294c4f)
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
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.
Replace invalid
//comments with#in YAML examples, and move inline comments out of JSON strings into proper YAML-level#comments.