style: fix clippy::missing_errors_doc#225
Merged
Brooooooklyn merged 4 commits intomainfrom Oct 15, 2025
Merged
Conversation
Add # Errors documentation sections to public functions that return Result: - Exec::resolve() - Documents PATH search and shebang parsing errors - ensure_env() - Documents EINVAL on conflicting env values - decode_payload_from_env() - Documents env var, base64, and bincode errors - PreExec::run() - Documents infallible nature - handle_exec() - Documents resolution and env operation errors 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Member
Author
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds missing error documentation to public functions to satisfy clippy::missing_errors_doc and makes a small idiomatic cleanup.
- Documented error conditions for several public functions (resolve, ensure_env, decode_payload_from_env, handle_exec, PreExec::run).
- Minor doc formatting improvements (code formatting for identifiers).
- Small refactor to use Option::is_none_or in a filter.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| crates/fspy_shared_unix/src/exec/mod.rs | Adds Errors sections for Exec::resolve and ensure_env. |
| crates/fspy_shared_unix/src/payload.rs | Documents error cases for decoding payload from env. |
| crates/fspy_shared_unix/src/spawn/mod.rs | Adds documentation for handle_exec, including error conditions. |
| crates/fspy_shared_unix/src/spawn/macos.rs | Documents PreExec::run and its infallible behavior. |
| crates/vite_task/src/config/mod.rs | Docstring formatting (backticks around type names). |
| crates/vite_task/src/fingerprint.rs | Replaces map_or with Option::is_none_or in ignore filter. |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: LongYinan <lynweklm@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: LongYinan <lynweklm@gmail.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: LongYinan <lynweklm@gmail.com>
Brooooooklyn
force-pushed
the
fix/clippy-missing-errors-doc
branch
from
087fa89 to
93f8d18
Compare
fengmk2
approved these changes
Oct 15, 2025
This was referenced Oct 15, 2025
Member
Author
Merge activity
|
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 # Errors documentation sections to public functions that return Result:
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com