Skip to content

docs(codecs): fix wording in decoder and framing doc strings#25382

Open
thomasqueirozb wants to merge 2 commits intomasterfrom
docs/decoder-framing-wording-fixes
Open

docs(codecs): fix wording in decoder and framing doc strings#25382
thomasqueirozb wants to merge 2 commits intomasterfrom
docs/decoder-framing-wording-fixes

Conversation

@thomasqueirozb
Copy link
Copy Markdown
Contributor

Summary

Fix wording issues in doc strings across shared decoder format and framing files, based on review feedback on #25312.

Vector configuration

NA

How did you test this PR?

Doc-string only changes; no behavior change.

Change Type

  • Bug fix
  • New feature
  • Dependencies
  • Non-functional (chore, refactoring, docs)
  • Performance

Is this a breaking change?

  • Yes
  • No

Does this PR include user facing changes?

  • Yes. Please add a changelog fragment based on our guidelines.
  • No. A maintainer will apply the no-changelog label to this PR.

References

@thomasqueirozb thomasqueirozb added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label May 6, 2026
@github-actions github-actions Bot added docs review on hold The documentation team reviews PRs only after a PR is approved by the COSE team. domain: external docs Anything related to Vector's external, public documentation labels May 6, 2026
@thomasqueirozb thomasqueirozb marked this pull request as ready for review May 6, 2026 19:00
@thomasqueirozb thomasqueirozb requested review from a team as code owners May 6, 2026 19:00
@github-actions github-actions Bot removed the docs review on hold The documentation team reviews PRs only after a PR is approved by the COSE team. label May 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain: external docs Anything related to Vector's external, public documentation no-changelog Changes in this PR do not need user-facing explanations in the release changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants