Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change comments in line protocol syntax to be self-descriptive # #5821

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

maximal
Copy link

@maximal maximal commented Feb 4, 2025

I suppose, the current

// Syntax
<measurement>[,<tag_key>=<tag_value>[,<tag_key>=<tag_value>]] <field_key>=<field_value>[,<field_key>=<field_value>] [<timestamp>]

// Example
myMeasurement,tag1=value1,tag2=value2 fieldKey="fieldValue" 1556813561098000000

can confuse new users by implying that // can be used to comment lines in the line protocol itself.

So, I propose to change this snippet to

# Syntax
<measurement>[,<tag_key>=<tag_value>[,<tag_key>=<tag_value>]] <field_key>=<field_value>[,<field_key>=<field_value>] [<timestamp>]

# Example
myMeasurement,tag1=value1,tag2=value2 fieldKey="fieldValue" 1556813561098000000

and use some #-comment language descriptor in the Markdown code block (like Python).

@maximal maximal changed the title Change comments in line protocol syntacs to be self-descriptive # Change comments in line protocol syntax to be self-descriptive # Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant