influxdata / influxdata/docs-v2
'line protocol elements' is unclear
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
I’m finding[ this docs page](https://docs.influxdata.com/influxdb/cloud/reference/syntax/annotated-csv/#example-line-protocol-elements-in-datatype-annotation) on line protocol elements kind of confusing.
There are examples of flux CSV with line protocol elements: https://docs.influxdata.com/influxdb/cloud/reference/syntax/annotated-csv/#example-line-protocol-elements-in-datatype-annotation
Then there’s a warning that I can’t use those in flux: https://docs.influxdata.com/influxdb/cloud/reference/syntax/annotated-csv/#:~:text=Flux%20only%20supports%20data%20types%20in%20the%20%23datatype%20annotation.%20It%20does%20does%20not%20support%20line%20protocol%20elements.
An example of where the ‘line protocol elements’ might show up / how I _can_ use them might be helpful.
@jstirnaman says these might be for the CLI - if true, it seems like bad design to have a special data format that only works for the CLI, when either line protocol or 'real' flux CSV might be better. Especially since this format has the `datatypes` header separated with a space instead of a comma.
##### Relevant URLs
https://docs.influxdata.com/influxdb/cloud/reference/syntax/annotated-csv/#example-line-protocol-elements-in-datatype-annotation
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the annotated CSV documentation page and review the “line protocol elements” example, the Flux limitation warning, and the linked references. Clarify where these elements appear, whether they are used by the CLI, and how they differ from Flux CSV; update the page with an accurate usage example and explanation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100