Repository navigation
chore(config): document errors and panics instead of allowing doc lints - #26901
Merged
Merged
Conversation
JinchengCao
added
the
no-changelog
This was referenced Oct 27, 2026
Merged
JinchengCao
marked this pull request as ready for review
October 27, 2026 19:27
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
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[bot]](https://avatars.githubusercontent.com/u/16866914?s=60&v=4){kind=small}
There was a problem hiding this comment.
More details
The documented error and panic conditions align with the existing implementations, including methods that currently never return errors. No reportable documentation inaccuracies were identified.
🤖 Bits Code Review · Commit e3c30f0
pront
approved these changes
Oct 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Replaces the 28 deferred
missing_errors_doc/missing_panics_docallows insrc/config(excludingsrc/config/loading) with# Errors/# Panicssections. 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 --lib --bin vector --tests --no-default-features --features api -- -D warningsmake check-fmtDoes this PR include user facing changes?
no-changeloglabel to this PR.