Skip to content

chore(codecs): document decoding errors and panics instead of allowing doc lints - #26904

Merged
JinchengCao merged 2 commits into
masterfrom
JinchengCao-codecs-decoding-doc-lints
Oct 28, 2026
Merged

JinchengCao merged 2 commits into
masterfrom
JinchengCao-codecs-decoding-doc-lints

Conversation

@JinchengCao

@JinchengCao JinchengCao commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

Summary

Replaces the 13 deferred missing_errors_doc / missing_panics_doc allows in lib/codecs/src/decoding with # Errors / # Panics sections. Docs only, no code changes.

References

Related: #23659

This is part of the doc-lint cleanup for #23659: #26896, #26900, #26901, #26902, #26903, #26904, #26905.

Vector configuration

NA

How did you test this PR?

  • cargo clippy -p codecs --all-targets with --all-features and --no-default-features, -D warnings
  • cargo doc -p codecs --no-deps --all-features
  • Lint-active check: removing one of the new sections makes the lint fire
  • make check-fmt

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.

@JinchengCao
JinchengCao marked this pull request as ready for review October 27, 2026 19:27
@JinchengCao
JinchengCao requested a review from a team as a code owner October 27, 2026 19:27
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-27T19:30:36.416051Z 15ae51d Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@datadoghq-integration datadoghq-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bits Code Review: PASS

More details

The new error and panic documentation matches the existing decoding implementations. No actionable documentation defects were identified.

Was this helpful? React 👍 or 👎

Open Bits AI session

🤖 Bits Code Review · Commit 15ae51d

@JinchengCao
JinchengCao added this pull request to the merge queue Oct 28, 2026
Merged via the queue into master with commit 6fe7c06 Oct 28, 2026
112 checks passed
@JinchengCao
JinchengCao deleted the JinchengCao-codecs-decoding-doc-lints branch October 28, 2026 15:32
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 28, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

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.

2 participants