influxdata / flux

Flux is a lightweight scripting language for querying databases (like InfluxDB) and working with data. It's part of InfluxDB 1.7 and 2.0, but can be run independently of those.
https://influxdata.com
MIT License
769 stars 153 forks source link

docs: update comments to clarify behaviour #5506

Closed btasker closed 1 month ago

btasker commented 1 month ago

This updates the comments for influxdb.cardinality() to mirror the docs changes proposed in https://github.com/influxdata/docs-v2/pull/5629

The changes made:

Updates are being made to the comments because the docs are nominally generated from the comments, so we need to make sure the docs changes aren't lost if they're ever regenerated.

Checklist

Dear Author :wave:, the following checks should be completed (or explicitly dismissed) before merging.

Dear Reviewer(s) :wave:, you are responsible (among others) for ensuring the completeness and quality of the above before approval.