Skip to content

docs(inputs.opcua_listener): Use TOML comments in group example#19203

Open
jstirnaman wants to merge 1 commit into
influxdata:masterfrom
jstirnaman:telegraf-pr/opcua-listener-comments
Open

docs(inputs.opcua_listener): Use TOML comments in group example#19203
jstirnaman wants to merge 1 commit into
influxdata:masterfrom
jstirnaman:telegraf-pr/opcua-listener-comments

Conversation

@jstirnaman

@jstirnaman jstirnaman commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Summary

The node_ids group example used C-style // comments, which are 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 on the //;
after, the block passes TOML parsing.

Note: the same example also uses an outdated inline-array form for node_ids,
tracked separately in #19189 and out of scope here.

Checklist

Related issues

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

The node_ids group example used C-style // comments, which are 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/input 1. Request for new input plugins 2. Issues/PRs that are related to input plugins labels Jun 30, 2026
@jstirnaman jstirnaman marked this pull request as ready for review June 30, 2026 19:00
@skartikey

Copy link
Copy Markdown
Contributor

@jstirnaman The node_ids group example used C-style // comments, which are invalid in TOML. Switching the three lines to # is correct: TOML uses #, and inline # comments after array elements parse fine. README-only prose block, so no sample.conf edit or make docs needed.

@skartikey skartikey changed the title docs(inputs.opcua_listener): use TOML comments in group example docs(inputs.opcua_listener): Use TOML comments in group example Jul 1, 2026
@srebhan

srebhan commented Jul 1, 2026

Copy link
Copy Markdown
Member

@jstirnaman can you please restore the PR description template, especially the AI boxes?!

@jstirnaman

Copy link
Copy Markdown
Contributor Author

@jstirnaman can you please restore the PR description template, especially the AI boxes?!

@srebhan Done for all 5 PRs. Apologies.

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/input 1. Request for new input plugins 2. Issues/PRs that are related to input plugins

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants