docs(hooks): add doc comments to all public types#2447
Merged
Conversation
Contributor
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
Contributor
There was a problem hiding this comment.
HUQIANTAO has reached the 50-review limit for trial accounts. To continue receiving code reviews, upgrade your plan.
Owner
|
Thanks for filling in the hooks docs. I pushed a tiny maintainer follow-up to make the HookSink error-handling wording match the current dispatcher behavior: sink errors are discarded so hooks stay best-effort. Local checks passed in the PR worktree: cargo fmt --all --check, cargo test -p codewhale-hooks --all-features --locked, and git diff --check. |
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add doc comments to all public types in the hooks crate: HookEvent, HookSink trait, StdoutHookSink, JsonlHookSink, WebhookHookSink, UnixSocketHookSink, and HookDispatcher.
Greptile Summary
The review has been completed and submitted via the greptile-review tools. One P2 documentation inaccuracy was found in the
HookSinktrait doc where it claims errors are "logged" when they are actually silently discarded byHookDispatcher::emit.Confidence Score: 4/5
Safe to merge; the change is documentation-only and does not touch any runtime logic.
All comments are accurate except for one sentence in the HookSink trait doc that says errors are logged when they are actually silently discarded by HookDispatcher::emit.
crates/hooks/src/lib.rs around lines 98-101 in the HookSink trait doc.
Reviews (1): Last reviewed commit: "docs(hooks): add doc comments to all pub..." | Re-trigger Greptile