Skip to content

docs(outputs.dynatrace): Use TOML comment in api_token example#19204

Open
jstirnaman wants to merge 1 commit into
influxdata:masterfrom
jstirnaman:telegraf-pr/dynatrace-comment
Open

docs(outputs.dynatrace): Use TOML comment in api_token example#19204
jstirnaman wants to merge 1 commit into
influxdata:masterfrom
jstirnaman:telegraf-pr/dynatrace-comment

Conversation

@jstirnaman

@jstirnaman jstirnaman commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Summary

The api_token example used a C-style // comment, which is invalid in TOML.
Use # so the snippet parses if copied as-is.

This fix is in a freestanding example block in the README prose, not the
generated @sample.conf block (which is separate in this README and
unaffected), so no sample.conf change or make docs run is needed.

Found while adding code-block linting to the InfluxData docs site, which
generates the published plugin docs from these READMEs.

Verified in Telegraf 1.39.1: before, line 4: invalid TOML syntax; after, the
config loads (Loaded inputs: cpu).

Checklist

Related issues

Related to #19201 (tracking issue for this cleanup; item resolved in this PR)

The example used a C-style // comment, which is invalid in TOML. Use #
so the snippet parses if copied as-is.
@telegraf-tiger telegraf-tiger Bot added docs Issues related to Telegraf documentation and configuration descriptions plugin/output 1. Request for new output plugins 2. Issues/PRs that are related to out plugins labels Jun 30, 2026
@jstirnaman jstirnaman marked this pull request as ready for review June 30, 2026 18:59
@skartikey skartikey self-assigned this Jul 1, 2026
@skartikey skartikey changed the title docs(outputs.dynatrace): use TOML comment in api_token example docs(outputs.dynatrace): Use TOML comment in api_token example Jul 1, 2026
@skartikey

Copy link
Copy Markdown
Contributor

@jstirnaman The api_token example used a C-style // comment, which is invalid in TOML. Switching to # is correct: TOML uses #, and an inline # comment after a value parses fine. README-only prose block, so no sample.conf edit or make docs needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Issues related to Telegraf documentation and configuration descriptions plugin/output 1. Request for new output plugins 2. Issues/PRs that are related to out plugins

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants