docs: add missing error docs for listing and retrieval commands - #306
docs: add missing error docs for listing and retrieval commands#306matta wants to merge 1 commit into
Conversation
- Added `# Errors` sections for `run_next`, `run_list`, and `run_search` in `crates/pebble/src/commands.rs` and `crates/pebble/src/commands/listing.rs` - Fixed summary line verbs to use third-person singular present tense - Resolved missing error doc clippy warnings for the affected functions - Formatted `NotFoundError` intra-doc link properly - Validated with cargo test, clippy, and rustdoc Co-authored-by: matta <37314+matta@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
|
Merging to
|
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the clarity and completeness of the API documentation for core command functions. By introducing detailed error sections and standardizing doc comments, it improves developer understanding of potential failure modes and resolves existing linting warnings, contributing to a more robust and maintainable codebase. Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds helpful # Errors sections to the documentation for run_next, run_list, and run_search, improving clarity on their failure modes. The changes correctly follow Rust's documentation conventions, including updating summary lines to the third-person singular present tense. I've found one minor inaccuracy in the error documentation for run_next where an error is only returned in non-JSON mode, and I've suggested a small change to clarify this behavior.
| /// | ||
| /// Returns an error in the following cases: | ||
| /// * The task graph cannot be loaded from the tasks directory. | ||
| /// * No ready tasks are found (returns a [`NotFoundError`]). |
There was a problem hiding this comment.
The documentation for this error condition is slightly inaccurate. The NotFoundError is only returned when not in JSON mode (ctx.json is false). In JSON mode, an empty list of tasks is returned successfully. The documentation should clarify this to avoid confusion for consumers of this function.
| /// * No ready tasks are found (returns a [`NotFoundError`]). | |
| /// * No ready tasks are found when not using JSON output (returns a [`NotFoundError`]). |
1 participant
This patch resolves
clippy::missing_errors_docwarnings forrun_next,run_list, andrun_searchpublic functions by adding well-formed# Errorssections documenting failure conditions. It strictly adheres to RFC 1574 by updating the summary lines to use third-person singular present tense and uses correctly formatted intra-doc links for referenced types likeNotFoundError.PR created automatically by Jules for task 16285063544738363878 started by @matta