Change comments in line protocol syntax to be self-descriptive # - #7678
Closed
maximal wants to merge 1 commit into
Closed
Change comments in line protocol syntax to be self-descriptive ##7678maximal wants to merge 1 commit into
##7678maximal wants to merge 1 commit into
Conversation
jstirnaman
added a commit
that referenced
this pull request
Aug 25, 2026
#7678 and #5821 fixed the misleading `js`/`//` comment syntax in the line protocol "Syntax" block, but relabeled it `python`, which is still not what the block is (a placeholder grammar, not runnable Python or JS). Split each occurrence into a `text` fence for the placeholder syntax and a standalone `lp` fence for the real example, matching this repo's line-protocol fence convention. Also fixed the several other `js`/`sh`-tagged blocks in the same two shared files that are real, standalone line protocol (not templates) to use `lp`, since they were failing codeblock lint as invalid JavaScript. PR #5821 targeted content/influxdb/v2/reference/syntax/line-protocol.md, which is now a stub whose body is sourced from content/shared/influxdb-v2/reference/syntax/line-protocol.md; applied its intent to the shared file instead. Co-authored-by: MaximAL <almaximal@gmail.com>
Contributor
|
Thanks for the fix! Folded into #7705, which also splits the syntax template from the runnable example (so it's not mislabeled as |
Contributor
Author
|
@jstirnaman, thanks! |
jstirnaman
added a commit
that referenced
this pull request
Aug 25, 2026
#7678 and #5821 fixed the misleading `js`/`//` comment syntax in the line protocol "Syntax" block, but relabeled it `python`, which is still not what the block is (a placeholder grammar, not runnable Python or JS). Split each occurrence into a `text` fence for the placeholder syntax and a standalone `lp` fence for the real example, matching this repo's line-protocol fence convention. Also fixed the several other `js`/`sh`-tagged blocks in the same two shared files that are real, standalone line protocol (not templates) to use `lp`, since they were failing codeblock lint as invalid JavaScript. PR #5821 targeted content/influxdb/v2/reference/syntax/line-protocol.md, which is now a stub whose body is sourced from content/shared/influxdb-v2/reference/syntax/line-protocol.md; applied its intent to the shared file instead. Co-authored-by: MaximAL <almaximal@gmail.com>
jstirnaman
added a commit
that referenced
this pull request
Aug 25, 2026
#7678 and #5821 fixed the misleading `js`/`//` comment syntax in the line protocol "Syntax" block, but relabeled it `python`, which is still not what the block is (a placeholder grammar, not runnable Python or JS). Split each occurrence into a `text` fence for the placeholder syntax and a standalone `lp` fence for the real example, matching this repo's line-protocol fence convention. Also fixed the several other `js`/`sh`-tagged blocks in the same two shared files that are real, standalone line protocol (not templates) to use `lp`, since they were failing codeblock lint as invalid JavaScript. PR #5821 targeted content/influxdb/v2/reference/syntax/line-protocol.md, which is now a stub whose body is sourced from content/shared/influxdb-v2/reference/syntax/line-protocol.md; applied its intent to the shared file instead. Co-authored-by: MaximAL <almaximal@gmail.com>
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.
Similar to #5821.